Zum Hauptinhalt springen

Dokumentationsseiten verlinken

Erstelle sprachabhängige Content-, Überschriften-, Asset- und externe Links in Markdown.

Verwende eine $docs-Referenz für einen Link auf eine andere Dokumentationsseite. Ginko löst die Referenz zur passenden öffentlichen Route für die Sprache des Lesers auf.

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

Die Referenz verwendet die kanonischen englischen Routensegmente und nicht die lokalisierte öffentliche URL. Ginko ordnet diese Segmente der numerischen Dokumentidentität zu. Dieselbe Referenz gehört in die deutsche Übersetzung:

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

Auf der englischen Seite ergibt der Link /docs/authoring/navigation, auf der deutschen Seite /de/dokumentation/inhalte/navigation.

Überschrift verlinken

Hänge das in der Zielsprache generierte Fragment der Überschrift an die kanonische englische Routenreferenz an:

content/docs/leitfaden.md
[Sidebar-Anzeige festlegen]($docs/authoring/navigation#sidebar-anzeige-festlegen)

Verwende ein lokales Fragment, wenn die Überschrift auf derselben Seite steht:

content/docs/leitfaden.md
[Zur Installation springen](#installation)

Halte Überschriftentexte nach der Veröffentlichung stabil. Wenn du eine Überschrift änderst, ändert sich auch ihr generiertes Fragment.

Anwendungsrouten und Assets verlinken

Verwende eine root-relative URL für eine Nuxt-Route, die nicht aus der Docs-Collection stammt:

content/docs/support.md
[Statusseite öffnen](/status)

Referenziere öffentliche Assets vom Website-Stamm aus:

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

Lege dieses Bild unter public/images/acme-wordmark.svg ab.

Externe Websites verlinken

Verwende eine vollständige HTTPS-URL und benenne das Ziel:

content/docs/framework.md
[Nuxt-Dokumentation lesen](https://nuxt.com/docs)

Schreibe für Links zwischen Dokumentationsseiten keine lokalisierten öffentlichen Pfade wie /de/dokumentation/.... $docs-Referenzen überstehen Änderungen deutscher Slugs, und der Content-Build schlägt fehl, wenn ein Ziel oder ein #anchor nicht mehr existiert. Benenne ein englisches Routensegment oder eine Überschrift nur um, wenn du die Referenzen darauf gleichzeitig aktualisierst.