Commit Graph

3 Commits

Author SHA1 Message Date
Jan Tojnar
6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Ryan Mulligan
b8344f9e5c doc: explicit Markdown anchors for top-level headings; remove metadata
I used the existing anchors generated by Docbook, so the anchor part
should be a no-op. This could be useful depending on the
infrastructure we choose to use, and it is better to be explicit than
rely on Docbook's id generating algorithms.

I got rid of the metadata segments of the Markdown files, because they
are outdated, inaccurate, and could make people less willing to change
them without speaking with the author.
2021-01-01 10:02:57 -08:00
Lucas Eduardo
543f084d62
doc: TeX Live to CommonMark
* converted texlive doc to markdown

Signed-off-by: GitHub <noreply@github.com>

* Remove frontmatter (suggestion)

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* Add anchor (suggestion)

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* apply suggestions from @ryantm

Signed-off-by: GitHub <noreply@github.com>

* fix nesting of codeblocks into list items as suggested by @jtojnar

Signed-off-by: GitHub <noreply@github.com>

* add anchors for subtopics as said by @jtojnar

Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>
2020-12-02 21:15:18 -08:00