diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2021-06-05 21:22:45 +0200 |
---|---|---|
committer | Jan Tojnar <jtojnar@gmail.com> | 2021-06-07 06:34:59 +0200 |
commit | 6ecc641d087df8b8896ebd876bba592e981877c9 (patch) | |
tree | c3dc98e6b6a4a6474b21ad06e7bbc96d0e8abaf5 /doc/contributing/contributing-to-documentation.chapter.md | |
parent | ce6b1a4f8f9cbbb7fd2d1c637bcc39fff1ef49df (diff) | |
download | nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.tar nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.tar.gz nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.tar.bz2 nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.tar.lz nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.tar.xz nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.tar.zst nixpkgs-6ecc641d087df8b8896ebd876bba592e981877c9.zip |
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.
Diffstat (limited to 'doc/contributing/contributing-to-documentation.chapter.md')
-rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index 05b00d9bdda..44feac7fbf7 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -25,7 +25,7 @@ If the build succeeds, the manual will be in `./result/share/doc/nixpkgs/manual. ## Syntax {#sec-contributing-markup} -As per [RFC 0062](https://github.com/NixOS/rfcs/pull/72), all new documentation content should be written in [CommonMark](https://commonmark.org/) Markdown dialect. +As per [RFC 0072](https://github.com/NixOS/rfcs/pull/72), all new documentation content should be written in [CommonMark](https://commonmark.org/) Markdown dialect. Additionally, the following syntax extensions are currently used: |