Skip to main content
`Ctrl`+`K`

# Linking in Markdown

2025-08-26

2 min read time

## Markdown

### Cross References to Other Projects

The `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:

    {doc}`Text here<project_name:path/to/page_name>`

Cross-references are achieved via Intersphinx. For more information, refer to the Sphinx documentation or Read the Docs documentation on Intersphinx.

#### Example

The following Markdown:

    {doc}`ROCm Documentation<rocm:about/license>`

will be rendered as the following link:

ROCm Documentation

### Relative Links to Current Project

#### Example

The following Markdown:

    [Link Text](../index)

will be rendered as the following link:

Link Text

### Absolute Links to External Sites

For other links, usual Markdown conventions should be used.

#### Example

The following Markdown:

    [Link Text](https://github.com/ROCm/ROCm)

will be rendered as the following link:

Link Text