Linking in Docker Documentation

content/contribute/components/links.md

87ab78de1d58625021778e73f81313036463d00cd2f0351300000003000002e7

---
description: components and formatting examples used in Docker's docs
title: Links
toc_max: 3
---

## Examples

- [External links](https://docker.com) open in a new tab
- [Internal links](links.md) open in the same tab

You can use relative links, using source filenames,
or you can use absolute links for pages as they appear on the final site.

#### Links to auto-generated content

When you link to heading IDs in auto-generated pages, such as CLI reference content,
you won't get any help from your editor in resolving the anchor names. That's
because the pages are generated at build-time and your editor or LSP doesn't know
about them in advance.

## Syntax

```md
[External links](https://docker.com)
[Internal links](links.md)
```

Chunks

47278149 (1st chunk of `content/contribute/components/links.md`)

Title: Linking in Docker Documentation

Summary

This section describes how to create external and internal links in Docker documentation using Markdown syntax. External links open in a new tab, while internal links open in the same tab. Relative links using source filenames or absolute links can be used. Special attention should be given when linking to auto-generated content, such as CLI reference, as the anchor names are resolved at build-time.