diff options
author | Jan Tojnar <jtojnar@gmail.com> | 2021-09-07 21:29:26 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-07 21:29:26 +0200 |
commit | 1e75936926bafb8c517eb3f0d73f9e963ae6c441 (patch) | |
tree | f546fa97e6189309586728f65b26ec00d0dea82e /doc/contributing | |
parent | 82d19cb068d7213c8beaa96220f1d81d57a28381 (diff) | |
parent | 7baf180128a8422629b5178354ffd5961afd3702 (diff) |
Merge pull request #130047 from NixOS/doc-manpage-role
doc: Add support for manpage references
Diffstat (limited to 'doc/contributing')
-rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index 2f7ae32259c4d..178fdb36262b8 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -52,6 +52,13 @@ Additionally, the following syntax extensions are currently used: This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing). +- []{#ssec-contributing-markup-inline-roles} + If you want to link to a man page, you can use `` {manpage}`nix.conf(5)` ``, which will turn into {manpage}`nix.conf(5)`. + + The references will turn into links when a mapping exists in {file}`doc/build-aux/pandoc-filters/unix-man-urls.lua`. + + This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/syntax/syntax.html#roles-an-in-line-extension-point). Though, the feature originates from [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-manpage) with slightly different syntax. + - []{#ssec-contributing-markup-admonitions} **Admonitions**, set off from the text to bring attention to something. |