Links & Navigation

MDX unterstützt standardmäßige Markdown-Links sowie Jamdesk-spezifische Muster zum Verknüpfen von Seiten, zum Verankern von Überschriften und zum Verweisen auf externe URLs.

Interne Links

Verknüpfe andere Seiten deiner Dokumentation über relative Pfade:

Read the [getting started guide](/quickstart) first.

See the [Card component](/components/card) for more options.

Auf Überschriften verlinken

Verlinke direkt auf einen Abschnitt mithilfe von Anker-Links:

See [configuration options](/config/docs-json-reference#colors)

Aus Überschriften werden automatisch Anker aus ihrem Text generiert:

• ## Getting Started → #getting-started
• ## API Reference → #api-reference

Externe Links

Verlinke auf externe Websites:

Check the [GitHub repository](https://github.com/example/repo).

Externe Links werden automatisch mit sicheren Einstellungen in einem neuen Tab geöffnet.

Mit Cards verlinken

Verwende für hervorgehobene Navigation Cards anstelle von Inline-Links:

<Card title="Quickstart" icon="rocket" href="/quickstart">

  Get up and running in 5 minutes

</Card>

Card-Gruppen

Gruppiere zusammengehörige Links:

<Columns cols={2}>
  <Card title="Installation" icon="download" href="/cli/overview">

    Install the CLI

</Card>
  <Card title="Configuration" icon="gear" href="/config/docs-json-reference">

    Configure your project

</Card>
</Columns>

Best Practices

{/* Good */}
Learn more in our [authentication guide](/quickstart).

{/* Avoid */}
For more info, [click here](/quickstart).

{/* Good - links to specific section */}
Configure [OAuth settings](/quickstart#whats-next).

{/* Less helpful - links to entire page */}
See the [auth docs](/quickstart) for OAuth settings.

jamdesk broken-links

Auf defekte Links prüfen

Die Jamdesk CLI kann nach defekten Links suchen:

jamdesk broken-links

Beispielausgabe:

docs/getting-started.mdx:15 - /docs/quikstart
  Did you mean: /docs/quickstart

Found 1 broken link in 45 files.

Führe diesen Befehl vor dem Bereitstellen aus, um Tippfehler und veraltete Verweise zu finden.

Defekte Links automatisch korrigieren

Wenn ein defekter Link ein eindeutig korrektes Ziel hat (ein Tippfehler in einem Anker oder eine Ankerabweichung zwischen Locales, weil eine übersetzte Seite ihre Überschriften umbenannt hat), korrigiert jamdesk fix den Link für dich:

jamdesk fix --dry-run   # preview every planned fix, write nothing
jamdesk fix             # apply after a y/N confirmation

Ein Link wird nur umgeschrieben, wenn der korrigierte Anker eine echte Überschrift auf der Zielseite ist. Alles Uneindeutige bleibt zur manuellen Prüfung bestehen. Siehe Defekte Links automatisch korrigieren.

Erkennung interner Links

Links ohne https:// werden als intern behandelt und anhand deiner Dokumentationsseiten validiert. Der Validator prüft, ob die Zielseite in der Navigation deiner docs.json vorhanden ist.

Bei Websites, die hostAtDocs verwenden (Dokumentation, die unter einem Unterpfad wie /docs gehostet wird), erhalten interne Links zur Laufzeit automatisch ein Präfix. Schreibe Pfade relativ zum Stammverzeichnis deiner Dokumentation; das Präfix /docs wird automatisch hinzugefügt:

{/* Just write the docs path — auto-prefixed to /docs/config/docs-json-reference */}
See the [Reference](/config/docs-json-reference).

Seiten umbenennen

Wenn du eine Seite umbenennst, werden Links ungültig. Verwende die CLI, um alle Verweise zu aktualisieren:

jamdesk rename api/old-name.mdx api/new-name.mdx

Dadurch wird automatisch:

• die Datei umbenannt
• die Navigation in docs.json aktualisiert
• werden Links auf allen anderen Seiten korrigiert

Wie geht es weiter?