From 3c78ad2561a831dcbe6e193465f787019638d56b Mon Sep 17 00:00:00 2001 From: Jan Tojnar Date: Sun, 6 Jun 2021 13:17:54 +0200 Subject: 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 --- doc/contributing/contributing-to-documentation.chapter.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc/contributing/contributing-to-documentation.chapter.md') 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. -- cgit 1.4.1