diff options
| author | Jan Tojnar <jtojnar@gmail.com> | 2021-06-06 13:17:54 +0200 |
|---|---|---|
| committer | Jan Tojnar <jtojnar@gmail.com> | 2021-06-07 06:34:59 +0200 |
| commit | 3c78ad2561a831dcbe6e193465f787019638d56b (patch) | |
| tree | a25b53f1a3f821f714bf0f11e1c5ae8939ac1c4e /doc/contributing/contributing-to-documentation.chapter.md | |
| parent | adecb00f5a07ce3f5cc97e7ccf5d814f70f6704f (diff) | |
| download | nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.gz nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.bz2 nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.lz nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.xz nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.tar.zst nixpkgs-3c78ad2561a831dcbe6e193465f787019638d56b.zip | |
doc: Use markdown syntax for xrefs
Syntax is taken from MyST: https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
Diffstat (limited to 'doc/contributing/contributing-to-documentation.chapter.md')
| -rw-r--r-- | doc/contributing/contributing-to-documentation.chapter.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/contributing/contributing-to-documentation.chapter.md b/doc/contributing/contributing-to-documentation.chapter.md index 44feac7fbf7..2f7ae32259c 100644 --- a/doc/contributing/contributing-to-documentation.chapter.md +++ b/doc/contributing/contributing-to-documentation.chapter.md @@ -47,6 +47,11 @@ Additionally, the following syntax extensions are currently used: - []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`. ``` +- []{#ssec-contributing-markup-automatic-links} + If you **omit a link text** for a link pointing to a section, the text will be substituted automatically. For example, `[](#chap-contributing)` will result in [](#chap-contributing). + + This syntax is taken from [MyST](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing). + - []{#ssec-contributing-markup-admonitions} **Admonitions**, set off from the text to bring attention to something. |