colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix outdated contributing to documentation

Browse Source 
Co-authored-by: Shahar "Dawn" Or <mightyiampresence@gmail.com>
This commit is contained in:
Alejandro Sanchez Medina 2023-07-05 12:11:14 +02:00
parent fd3ce3bb2d
commit b751910048
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/contributing/contributing-to-documentation.chapter.md
View File

@ -25,6 +25,9 @@ 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-).
- []{#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).