Links & Navigation
Seiten verlinken, auf bestimmte Überschriften verweisen und externe URLs referenzieren. Mit Card-Navigation und Prüfung auf defekte Links.
MDX unterstützt standardmäßige Markdown-Links. Jamdesk ergänzt Muster für Seitenlinks, Überschriften-Anker und externe URLs.
Interne Links
Verlinke andere Seiten deiner Dokumentation mit relativen Pfaden:
Read the [getting started guide](/quickstart) first.
See the [Card component](/components/card) for more options.Verwende Pfade relativ zum Stammverzeichnis deiner Dokumentation, ohne die Dateiendung .mdx.
Auf Überschriften verlinken
Verlinke direkt auf einen Abschnitt mit Anker-Links:
See [configuration options](/config/docs-json-reference#colors)Überschriften erzeugen automatisch Anker aus ihrem Text:
## Erste Schritte→#erste-schritte## API-Referenz→#api-referenz
Externe Links
Verlinke externe Websites:
Check the [GitHub repository](https://github.com/example/repo).Externe Links öffnen sich in einem neuen Tab mit sicheren Einstellungen.
Mit Cards verlinken
Verwende Cards statt Inline-Links für auffällige Navigation:
<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
Sag den Lesern, wohin der Link führt:
{/* Good */}
Learn more in our [authentication guide](/quickstart).
{/* Avoid */}
For more info, [click here](/quickstart).Verlinke auf den spezifischsten relevanten Abschnitt:
{/* 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.Defekte Links frustrieren Leser. Führe regelmäßig Linkprüfungen durch:
jamdesk broken-linksDies durchsucht deine Dokumentation und meldet alle defekten internen Links.
Auf defekte Links prüfen
Die Jamdesk CLI kann nach defekten Links suchen:
jamdesk broken-linksBeispielausgabe:
docs/getting-started.mdx:15 - /docs/quikstart
Did you mean: /docs/quickstart
Found 1 broken link in 45 files.Führe dies vor dem Deployment aus, um Tippfehler und veraltete Referenzen abzufangen.
Defekte Links automatisch korrigieren
jamdesk fix repariert einen defekten Link, der genau ein eindeutiges korrektes Ziel hat (einen fehlerhaften Anker oder eine sprachübergreifende Anker-Abweichung, wenn eine übersetzte Seite ihre Überschriften umbenannt hat):
jamdesk fix --dry-run # preview every planned fix, write nothing
jamdesk fix # apply after a y/N confirmationEin Link wird nur umgeschrieben, wenn der korrigierte Anker eine tatsächlich existierende Überschrift auf der Zielseite ist. Alles Mehrdeutige wird zur manuellen Prüfung belassen. Siehe Defekte Links automatisch korrigieren.
Erkennung interner Links
Links ohne https:// gelten als intern und werden gegen deine Dokumentationsseiten geprüft. Der Validator prüft, ob die Zielseite in deiner docs.json-Navigation existiert.
Websites mit hostAtDocs (Dokumentation unter einem Unterpfad wie /docs) erhalten zur Laufzeit das Präfix /docs für interne Links. Schreibe Pfade relativ zum Stammverzeichnis deiner Dokumentation:
{/* Just write the docs path — auto-prefixed to /docs/config/docs-json-reference */}
See the [Reference](/config/docs-json-reference).Nicht zur Dokumentation gehörende Links (etwa Marketingseiten) sollten vollständige URLs verwenden: https://example.com/pricing.
Jeder /path-Link in deinem Dokumentationsinhalt wird als interner Dokumentationslink behandelt.
Seiten umbenennen
Das Umbenennen einer Seite bricht Links zu ihr. Aktualisiere jede Referenz mit der CLI:
jamdesk rename api/old-name.mdx api/new-name.mdxDieser Befehl:
- benennt die Datei um
- aktualisiert die
docs.json-Navigation - korrigiert Links in allen anderen Seiten