Skip to main content

Link documentation pages

Create locale-aware content links, heading links, asset links, and external links from Markdown.

Use a $docs reference for a link to another documentation page. Ginko resolves the reference to the correct public route for the reader's locale.

content/en/1.docs/3.authoring/1.write-content.md
[Configure the sidebar]($docs/authoring/navigation)

The reference uses the canonical English route segments, not the localized public URL. Ginko maps those segments to the document's numeric identity. The same reference belongs in the German translation:

content/de/1.dokumentation/3.inhalte/1.inhalte-schreiben.md
[Navigation gestalten]($docs/authoring/navigation)

On the English page it resolves to /docs/authoring/navigation. On the German page it resolves to /de/dokumentation/inhalte/navigation.

Append the heading fragment to the canonical English route reference:

content/docs/guide.md
[Choose a section control]($docs/authoring/navigation#choose-the-section-control)

Use a local fragment when the heading is on the current page:

content/docs/guide.md
[Jump to installation](#installation)

Keep heading text stable after publishing. Changing a heading also changes its generated fragment.

Use a root-relative URL for a Nuxt route that is not backed by the docs collection:

content/docs/support.md
[Open the status page](/status)

Reference public assets from the site root:

content/docs/brand.md
![Acme wordmark](/images/acme-wordmark.svg)

Store that image at public/images/acme-wordmark.svg.

Use a complete HTTPS URL and name the destination:

content/docs/framework.md
[Read the Nuxt documentation](https://nuxt.com/docs)

Do not write localized public paths such as /de/dokumentation/... for links between docs pages. $docs references survive German slug changes, and the content build fails when a destination or #anchor no longer exists. Rename an English route segment or a heading only when you are ready to update references that use it.