Skip to content

Commit 3ea1ef2

Browse files
committed
custom titles in .md
1 parent 92d36c6 commit 3ea1ef2

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

doc/sphinx-guides/source/contributor/documentation.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,16 +154,22 @@ If the page is written in Markdown (.md), use this form:
154154

155155
### Links
156156

157-
Getting links right with .rst files can be tricky.
157+
Getting links right can be tricky.
158158

159159
#### Custom Titles
160160

161-
You can use a custom title when linking to a document like this:
161+
In .rst files you can use a custom title when linking to a document like this:
162162

163163
:doc:`Custom title </api/intro>`
164164

165165
See also <https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html#the-doc-role>
166166

167+
In .md files, the same pattern can be used. Here's an example of using a custom title with a ref:
168+
169+
{ref}`Log in <account-log-in-options>`
170+
171+
See also <https://myst-parser.readthedocs.io/en/v0.16.1/syntax/syntax.html#targets-and-cross-referencing>
172+
167173
### Images
168174

169175
A good documentation is just like a website enhanced and upgraded by adding high quality and self-explanatory images. Often images depict a lot of written text in a simple manner. Within our Sphinx docs, you can add them in two ways: a) add a PNG image directly and include or b) use inline description languages like GraphViz (current only option).

0 commit comments

Comments
 (0)