summary refs log tree commit diff
path: root/doc/contributing/contributing-to-documentation.chapter.md
diff options
context:
space:
mode:
authorJan Tojnar <jtojnar@gmail.com>2021-07-12 18:40:33 +0200
committerJan Tojnar <jtojnar@gmail.com>2021-07-13 02:21:22 +0200
commit04b59b0328daaa2e11f5e387ad3ec475cf2d2028 (patch)
treec93741cf282e772100da2d366a23cfd099a04da5 /doc/contributing/contributing-to-documentation.chapter.md
parentc9139dfa1a001e32baa6fea9c9373d80c83e39e9 (diff)
downloadnixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.tar
nixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.tar.gz
nixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.tar.bz2
nixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.tar.lz
nixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.tar.xz
nixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.tar.zst
nixpkgs-04b59b0328daaa2e11f5e387ad3ec475cf2d2028.zip
doc: Linkify man page references
Diffstat (limited to 'doc/contributing/contributing-to-documentation.chapter.md')
-rw-r--r--doc/contributing/contributing-to-documentation.chapter.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md
index bf73a340bce..178fdb36262 100644
--- a/doc/contributing/contributing-to-documentation.chapter.md
+++ b/doc/contributing/contributing-to-documentation.chapter.md
@@ -53,7 +53,9 @@ 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)`.
+  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.