Liens et navigation
Créez des liens entre les pages, ancrez des titres spécifiques et référencez des URL externes. Inclut la navigation par Card et la vérification des liens cassés.
MDX prend en charge les liens Markdown standards ainsi que des patterns spécifiques à Jamdesk pour relier les pages entre elles, pointer vers des titres et référencer des URL externes.
Liens internes
Pour pointer vers d'autres pages de votre documentation, utilisez des chemins relatifs :
Read the [getting started guide](/quickstart) first.
See the [Card component](/components/card) for more options.Utilisez des chemins relatifs à la racine de votre documentation, sans l'extension .mdx.
Pointer vers un titre
Pour pointer directement vers une section, utilisez une ancre :
See [configuration options](/config/docs-json-reference#colors)Les titres génèrent automatiquement des ancres à partir de leur texte :
## Getting Started→#getting-started## API Reference→#api-reference
Liens externes
Pour pointer vers des sites externes :
Check the [GitHub repository](https://github.com/example/repo).Les liens externes s'ouvrent automatiquement dans un nouvel onglet avec des paramètres sécurisés.
Liens via des Cards
Pour une navigation plus visible, utilisez des Cards plutôt que des liens en ligne :
<Card title="Quickstart" icon="rocket" href="/quickstart">
Get up and running in 5 minutes
</Card>Groupes de Cards
Regroupez des liens connexes :
<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>Bonnes pratiques
Indiquez au lecteur où le lien mène :
{/* Good */}
Learn more in our [authentication guide](/quickstart).
{/* Avoid */}
For more info, [click here](/quickstart).Pointez vers la section la plus spécifique qui soit pertinente :
{/* Good - links to specific section */}
Configure [OAuth settings](/quickstart#what-s-next).
{/* Less helpful - links to entire page */}
See the [auth docs](/quickstart) for OAuth settings.Les liens cassés agacent les lecteurs. Lancez régulièrement une vérification des liens :
jamdesk broken-linksCela scanne votre documentation et signale tout lien interne cassé.
Vérifier les liens cassés
La CLI Jamdesk peut détecter les liens cassés :
jamdesk broken-linksExemple de sortie :
docs/getting-started.mdx:15 - /docs/quikstart
Did you mean: /docs/quickstart
Found 1 broken link in 45 files.
Lancez la commande avant de déployer pour attraper les fautes de frappe et les références obsolètes.
Comment les liens internes sont détectés
Les liens sans https:// sont considérés comme internes et validés par rapport aux pages de votre documentation. Le validateur vérifie que la page cible existe dans la navigation de votre docs.json.
Pour les sites qui utilisent hostAtDocs (documentation hébergée sous un sous-chemin comme /docs), les liens internes sont automatiquement préfixés à l'exécution. Écrivez les chemins relatifs à la racine de votre documentation — le préfixe /docs est ajouté pour vous :
{/* Just write the docs path — auto-prefixed to /docs/config/docs-json-reference */}
See the [Reference](/config/docs-json-reference).Les liens hors documentation (pages marketing, par exemple) doivent utiliser des URL complètes : https://example.com/pricing.
Tout lien en /path dans votre documentation est traité comme un lien interne vers la documentation.
Renommer des pages
Quand vous renommez une page, les liens se cassent. Utilisez la CLI pour mettre à jour toutes les références :
jamdesk rename api/old-name.mdx api/new-name.mdxCela fait automatiquement ceci :
- Renomme le fichier
- Met à jour la navigation dans
docs.json - Corrige les liens dans toutes les autres pages