Liens et navigation

MDX prend en charge les liens Markdown standard ainsi que des modèles spécifiques à Jamdesk pour créer des liens entre 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 à l'aide de chemins relatifs :

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

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

Créer un lien vers des titres

Créez un lien direct vers une section à l'aide de liens d'ancrage :

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 :

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.

Lien avec des Card

Pour une navigation plus visible, utilisez des Card plutôt que des liens en ligne :

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

  Get up and running in 5 minutes

</Card>

Groupes de Card

Regroupez les liens associés :

<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

{/* 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

Vérification des liens brisés

La CLI Jamdesk peut analyser les liens brisés :

jamdesk broken-links

Exemple de résultat :

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

Found 1 broken link in 45 files.

Exécutez cette commande avant le déploiement pour détecter les fautes de frappe et les références obsolètes.

Corriger automatiquement les liens brisés

Lorsqu'un lien brisé a une cible correcte non ambiguë (une ancre comportant une faute de frappe, ou une dérive d'ancre inter-locale où une page traduite a renommé ses titres), jamdesk fix la corrige pour vous :

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

Il ne réécrit un lien que lorsque l'ancre corrigée correspond à un titre réel sur la page cible, laissant tout élément ambigu pour une révision manuelle. Voir Correction automatique des liens brisés.

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 utilisant hostAtDocs (documentation hébergée sous un sous-chemin comme /docs), les liens internes sont automatiquement préfixés au moment de l'exécution. Écrivez des chemins relatifs à la racine de votre documentation ; le préfixe /docs est ajouté automatiquement :

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

Renommage de pages

Lorsque vous renommez une page, les liens sont brisés. Utilisez la CLI pour mettre à jour toutes les références :

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

Cette commande effectue automatiquement les actions suivantes :

• Renomme le fichier
• Met à jour la navigation de docs.json
• Corrige les liens dans toutes les autres pages

Et ensuite ?