Update doc/contributing/contributing-to-documentation.chapter.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
This commit is contained in:
Silvan Mosberger 2023-08-10 16:12:07 +02:00 committed by GitHub
parent b751910048
commit 731c21db95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -26,7 +26,7 @@ As per [RFC 0072](https://github.com/NixOS/rfcs/pull/72), all new documentation
Additional syntax extensions are available, all of which can be used in NixOS option documentation. The following extensions are currently used:
- []{#ssec-contributing-markup-tables}
[GFM tables](https://github.github.com/gfm/#tables-extension-).
Tables, using the [GitHub-flavored Markdown syntax](https://github.github.com/gfm/#tables-extension-).
- []{#ssec-contributing-markup-anchors}
Explicitly defined **anchors** on headings, to allow linking to sections. These should be always used, to ensure the anchors can be linked even when the heading text changes, and to prevent conflicts between [automatically assigned identifiers](https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/auto_identifiers.md).