Links
Internal Links (Absolute Path)
Use /docs/... absolute paths for in-site docs; clicks navigate within the site regardless of the current page location.
- Source
- Result
[Guide Home](/docs/guide/)Internal Links (Relative Path)
Relative paths use ./ for the current directory and ../ for the parent; they resolve relative to the current document's location.
- Source
- Result
[Code tutorial](./code)[Tabs tutorial](../advanced/tabs)./code: jumps to the "Code" tutorial in the same directory (basic)../advanced/tabs: jumps to the "Tabs" tutorial in the parentadvanceddirectory
Anchor Links (In-page)
Docusaurus auto-generates an anchor id for every heading (rule: strip punctuation, spaces become hyphens). Use #id for in-page jumps, and prepend the doc path for cross-page jumps. The anchor id of this page's "Internal Links (Absolute Path)" section is internal-links-absolute-path.
- Source
- Result
[Jump to "Internal Links (Absolute Path)"](#internal-links-absolute-path)[Jump to the anchor of the Links tutorial](/docs/guide/basic/links#internal-links-absolute-path)You can view the anchor id in the browser address bar or the "#" link next to a heading. For a semantic English id, write
## Heading {#custom-id}after the heading (requires MDX config support).
External Links
External links use a full https:// address and open in a new tab automatically.
- Source
- Result
[Docusaurus website](https://docusaurus.io)