Commit graph

9 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
Florian Engel 3329093c6a Remove repeating words from doc 2021-03-14 12:15:34 +01:00
Profpatsch b0c1583a0b doc: stdenv.lib -> lib
Part of: https://github.com/NixOS/nixpkgs/issues/108938

Changing the documentation to not refer to stdenv.lib is the first
step to make people use it directly.
2021-01-11 09:52:27 +01: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
Matthieu Coudron 8d05c66dc6 fixup! update 2020-06-07 20:12:56 +02:00
Matthieu Coudron 3042b38ce1 update 2020-06-06 20:20:27 +02:00
Matthieu Coudron 2909dc9f39 builds 2020-06-06 17:33:41 +02:00
Matthieu Coudron 404d057e89 Added an example about overlay 2020-06-06 17:33:39 +02:00
Matthieu Coudron 5cfcfc300b doc: update lua documentation
Reflects the recent changes to the lua infrastructure.
Packaging from luarocks should be encouraged.
2020-06-06 17:33:37 +02:00