1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
---
myst:
html_meta:
"description": "Setting up links in Markdown to other projects, current project and external sites in ROCm documentation"
"keywords": "Markdown links, Project linking, Project reference, Adding links in Markdown, Documentation settings"
---
# Linking in Markdown
## Markdown
### Cross References to Other Projects
The [`projects.yaml`](https://github.com/ROCm/rocm-docs-core/blob/develop/src/rocm_docs/data/projects.yaml)
configuration file contains the names of projects
that should be used when making links that cross-reference documentation sites.
When making links that cross-reference documentation sites, the following
format should be used:
```Markdown
{doc}`Text here<project_name:path/to/page_name>`
```
Cross-references are achieved via Intersphinx.
For more information, refer to the
[Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html)
or [Read the Docs documentation](https://docs.readthedocs.io/en/stable/guides/intersphinx.html)
on Intersphinx.
#### Example
The following Markdown:
```Markdown
{doc}`ROCm Documentation<rocm:about/license>`
```
will be rendered as the following link:
{doc}`ROCm Documentation<rocm:about/license>`
### Relative Links to Current Project
#### Example
The following Markdown:
```Markdown
[Link Text](../index)
```
will be rendered as the following link:
[Link Text](../index)
### Absolute Links to External Sites
For other links, usual Markdown conventions should be used.
#### Example
The following Markdown:
```Markdown
[Link Text](https://github.com/ROCm/ROCm)
```
will be rendered as the following link:
[Link Text](https://github.com/ROCm/ROCm)
|
