--- title: Liens et navigation description: Liez des pages, ancrez vers des titres et référencez des URL externes. Navigation par Card et vérification des liens cassés. --- MDX prend en charge les liens Markdown standard ainsi que les patterns spécifiques à Jamdesk pour créer des liens entre les pages, ancrer vers des titres et référencer des URL externes. ## Liens internes Créez des liens vers d'autres pages de votre documentation en utilisant des chemins relatifs : ```markdown 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`. ### Lien vers des titres Créez des liens directs vers une section en utilisant des liens d'ancrage : ```markdown 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 Créez des liens vers des sites externes : ```markdown 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 avec des Cards Pour une navigation proéminente, utilisez des Cards plutôt que des liens en ligne : ```mdx Get up and running in 5 minutes ``` Démarrez en 5 minutes ### Groupes de Cards Regroupez des liens connexes : ```mdx Install the CLI Configure your project ``` Installer le CLI Configurer votre projet ## Bonnes pratiques Indiquez aux lecteurs où mène le lien : ```markdown {/* Good */} Learn more in our [authentication guide](/quickstart). {/* Avoid */} For more info, [click here](/quickstart). ``` Liez à la section la plus spécifique et pertinente : ```markdown {/* 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 frustrent les lecteurs. Exécutez régulièrement des vérifications de liens : ```bash jamdesk broken-links ``` Cela analyse votre documentation et signale tous les liens internes cassés. ## Vérification des liens cassés Le CLI Jamdesk peut analyser les liens cassés : ```bash jamdesk broken-links ``` Exemple de sortie : ```text docs/getting-started.mdx:15 - /docs/quikstart Did you mean: /docs/quickstart Found 1 broken link in 45 files. ``` Exécutez cette commande avant de déployer pour détecter les fautes de frappe et les références obsolètes. ### Comment les liens internes sont détectés Les liens sans `https://` sont traité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 utilisant `hostAtDocs` (documentation hébergée sur un sous-chemin comme `/docs`), les liens internes sont **automatiquement préfixés** au moment de l'exécution. Écrivez les chemins relatifs à la racine de votre documentation — le préfixe `/docs` est ajouté automatiquement : ```markdown {/* Just write the docs path — auto-prefixed to /docs/config/docs-json-reference */} See the [Reference](/config/docs-json-reference). ``` Les liens non-docs (comme les pages marketing) doivent utiliser des URL complètes : `https://example.com/pricing`. Tout lien `/chemin` dans le contenu de votre documentation est traité comme un lien interne vers la documentation. ## Renommer des pages Lorsque vous renommez une page, les liens se cassent. Utilisez le CLI pour mettre à jour toutes les références : ```bash jamdesk rename api/old-name.mdx api/new-name.mdx ``` Cela effectue automatiquement : - Le renommage du fichier - La mise à jour de la navigation dans `docs.json` - La correction des liens dans toutes les autres pages ## Prochaines étapes Améliorez la découvrabilité et les métadonnées Définissez les titres, descriptions et champs SEO