NixOS/nix.dev
NixOS/nix.dev
1
0
Fork 0
mirror of https://github.com/NixOS/nix.dev.git synced 2024-10-18 14:32:43 -04:00
Code Activity

Mention linkcheck bug with GitHub heading anchors

Browse source
This commit is contained in:
Yuki Langley 2022-10-28 19:31:26 +02:00
parent a4a6ce812b
commit 7ba7bb2744
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md
View file

@ -183,3 +183,18 @@ Collect links at the end of each section, which are delimited by headings.
[Here is a discussion of different line wrapping styles.]: https://web.archive.org/web/20220519121408/https://mtsknn.fi/blog/4-1-wrapping-styles-for-markdown-prose-and-code-comments/ [Here is a discussion of different line wrapping styles.]: https://web.archive.org/web/20220519121408/https://mtsknn.fi/blog/4-1-wrapping-styles-for-markdown-prose-and-code-comments/
[reference links]: https://github.github.com/gfm/#reference-link [reference links]: https://github.github.com/gfm/#reference-link
### Notes
#### GitHub heading anchors fails linkcheck
Due to a [Sphinx bug][linkcheck gh bug], linkcheck fails when it verifies the
existence of GitHub heading anchors on rendered Markdown documents.
Until the bug is resolved, add the `user-content-` prefix to GitHub links
containing heading anchors.
For example, instead of
`https://github.com/cachix/install-nix-action#user-content-how-can-i-run-nixos-tests`,
use
`https://github.com/cachix/install-nix-action#user-content-how-can-i-run-nixos-tests`.