> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-docs-automation-github-pr-review.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Comment lier efficacement les pages de documentation

> Créez des liens internes, des ancres et des liens profonds, et préservez l'intégrité avec des redirections et des vérifications de liens cassés.

Les liens connectent votre documentation en un système cohérent. Ils aident les utilisateurs à découvrir du contenu connexe, à naviguer efficacement et à suivre un chemin logique à travers des sujets complexes. Des liens médiocres—texte d'ancrage vague, références croisées manquantes, URLs cassées—rendent la documentation plus difficile à utiliser et nuisent au SEO.

Ce guide explique comment créer différents types de liens dans Mintlify et comment maintenir l'intégrité des liens à mesure que votre documentation évolue.

<div id="internal-links">
  ## Liens internes
</div>

Liez vers d'autres pages de votre documentation en utilisant des chemins relatifs à la racine. Les chemins relatifs à la racine commencent à partir de la racine de votre répertoire de documentation et fonctionnent de manière cohérente, quel que soit l'emplacement de la page source dans votre structure de répertoires.

```mdx theme={null}
- [Quickstart guide](/quickstart)
- [API overview](/api-playground/overview)
- [Custom components](/customize/react-components)
```

Mintlify résout les chemins relatifs (`./` et `../`) en fonction de l'emplacement du fichier source dans le répertoire de votre projet. Cela fonctionne pour les liens, les images et les éléments JSX comme les balises `<Card>` et `<a>`.

```mdx theme={null}
- [Page voisine](./sibling-page)
- [Page de la section parente](../other-page)
```

Pour les fichiers `index.mdx`, les chemins relatifs sont résolus à partir du répertoire qui contient le fichier d'index. Par exemple, un lien `./setup` dans `guides/getting-started/index.mdx` est résolu en `/guides/getting-started/setup`.

Les liens préservent les fragments et les chaînes de requête.

```mdx theme={null}
[Instructions de configuration](./setup#step-1)
```

<Tip>
  Les chemins relatifs à la racine (commençant par `/`) fonctionnent mieux pour les liens internes car ils restent corrects si vous déplacez la page source vers un autre répertoire.
</Tip>

<div id="anchor-links">
  ## Liens d'ancrage
</div>

Les liens d'ancrage pointent vers des sections spécifiques au sein d'une page. Chaque titre génère automatiquement un ancrage basé sur son texte.

<div id="link-to-headers-on-the-same-page">
  ### Lier vers des titres sur la même page
</div>

Référencez les titres de la page actuelle en utilisant le symbole dièse :

```mdx theme={null}
[Jump to best practices](#best-practices)
```

<div id="link-to-headers-on-other-pages">
  ### Lier vers des titres sur d'autres pages
</div>

Combinez le chemin de la page avec l'ancrage :

```mdx theme={null}
- [Customize your playground](/api-playground/overview#customize-your-playground)
- [Cards properties](/components/cards#properties)
```

<div id="how-mintlify-generates-anchors">
  ### Comment Mintlify génère les ancrages
</div>

Mintlify crée automatiquement des ancrages à partir du texte des titres en convertissant en minuscules, en remplaçant les espaces par des tirets et en supprimant les caractères spéciaux.

| Texte du titre           | Ancrage généré        |
| ------------------------ | --------------------- |
| `## Getting Started`     | `#getting-started`    |
| `### API Authentication` | `#api-authentication` |
| `#### Step 1: Install`   | `#step-1-install`     |

<Note>
  Les titres avec la prop `noAnchor` ne génèrent pas de liens d'ancrage. Consultez [Formater le texte](/fr/create/text#disabling-anchor-links) pour plus de détails.
</Note>

<div id="custom-anchor-ids">
  ### IDs d'ancrage personnalisés
</div>

Remplacez l'ancrage généré automatiquement pour n'importe quel titre en ajoutant `{#custom-id}` au texte du titre :

```mdx theme={null}
## Configuration options {#config}
```

Ce titre est accessible à `#config` au lieu de `#configuration-options`. Les IDs personnalisés maintiennent les liens d'ancrage stables lorsque vous mettez à jour le texte du titre—utile pour les titres vers lesquels vous liez fréquemment. Consultez [Formater le texte](/fr/create/text#custom-heading-ids) pour plus de détails.

<div id="deep-links">
  ## Liens profonds
</div>

Les liens profonds pointent vers des états ou des emplacements spécifiques au sein d'une page, pas seulement vers la page elle-même.

<div id="accordion-deep-links">
  ### Liens profonds d'accordéon
</div>

Lorsqu'un utilisateur ouvre un accordéon, le hash de l'URL se met à jour pour refléter l'état ouvert. Visiter une URL avec ce hash ouvre automatiquement et fait défiler jusqu'à l'accordéon.

Par défaut, le hash est dérivé du `title` de l'accordéon. Utilisez la propriété `id` pour définir un hash personnalisé :

```mdx theme={null}
<Accordion title="Installation steps" id="install">
  ...
</Accordion>
```

Cet accordéon est accessible à `#install` au lieu du `#installation-steps` généré automatiquement. Consultez [Accordéons](/fr/components/accordions) pour en savoir plus.

<div id="api-playground-deep-links">
  ### Liens profonds de l'API playground
</div>

Pour ouvrir l'API playground dans un lien, ajoutez `?playground=open` à n'importe quelle URL de page d'endpoint :

```text theme={null}
https://your-docs-url/endpoint-path?playground=open
```

L'URL se met à jour lorsque les utilisateurs ouvrent ou ferment le playground. Utilisez les liens profonds du playground dans les conversations de support ou les flux d'intégration pour envoyer les utilisateurs directement vers le playground interactif d'un endpoint. Consultez [API playground](/fr/api-playground/overview#parameter-anchor-links) pour des informations sur les liens d'ancrage de paramètres.

<div id="external-links">
  ## Liens externes
</div>

Lorsque vous liez vers des ressources externes, rédigez un texte d'ancrage qui rend la destination claire :

```mdx theme={null}
See the [OpenAPI specification](https://swagger.io/specification/) in the Swagger documentation for details.
```

<div id="best-practices">
  ## Bonnes pratiques
</div>

<div id="write-descriptive-anchor-text">
  ### Rédigez un texte d'ancrage descriptif
</div>

Le texte d'ancrage doit indiquer aux utilisateurs où ils vont avant qu'ils ne cliquent. Les phrases vagues comme "cliquez ici" ou "en savoir plus" sont également des signaux SEO plus faibles que le texte descriptif.

<CodeGroup>
  ```mdx Good theme={null}
  See [Hidden pages](/organize/hidden-pages) for more information.
  [Configure custom domains](/customize/custom-domain)
  ```

  ```mdx Avoid theme={null}
  [Click here](/api-playground/overview)
  [Read more](/deploy/deployments)
  [See this page](/customize/custom-domain)
  ```
</CodeGroup>

<div id="link-prerequisites-explicitly">
  ### Liez les prérequis explicitement
</div>

Lorsqu'une page suppose des étapes préalables, liez-les en haut plutôt que de supposer que les utilisateurs les trouvent :

```mdx theme={null}
## Prerequisites

Before deploying your documentation, ensure you have:

- Completed the [quickstart guide](/quickstart)
- Configured your [custom domain](/customize/custom-domain)
- Set up [authentication](/deploy/authentication-setup) if needed
```

<div id="build-topic-clusters">
  ### Construisez des clusters de sujets
</div>

Liez le contenu connexe ensemble pour aider les utilisateurs—et les moteurs de recherche—à comprendre comment vous organisez votre documentation :

```mdx theme={null}
## Related topics

- [API authentication](/api-playground/overview#authentication)
- [Adding SDK examples](/api-playground/adding-sdk-examples)
- [Managing page visibility](/api-playground/managing-page-visibility)
```

<div id="check-for-broken-links">
  ### Vérifiez les liens cassés
</div>

Exécutez le CLI de Mintlify avant de publier pour détecter les liens internes et externes cassés :

```bash theme={null}
mint broken-links
```

<div id="update-links-when-reorganizing">
  ### Mettez à jour les liens lors d'une réorganisation
</div>

Lors du déplacement ou du renommage de pages :

1. Mettez à jour le chemin de la page dans votre configuration de navigation.
2. Configurez des redirections de l'ancien chemin vers le nouveau chemin.
3. Recherchez dans votre documentation les références à l'ancien chemin.
4. Mettez à jour tous les liens internes pour utiliser le nouveau chemin.
5. Exécutez `mint broken-links` pour vérifier.

<div id="use-redirects-for-moved-content">
  ### Utilisez des redirections pour le contenu déplacé
</div>

Lors du déplacement permanent de contenu, ajoutez des redirections pour éviter les liens cassés pour les utilisateurs qui ont mis en favoris ou partagé les anciennes URLs.

```json theme={null}
{
  "redirects": [
    {
      "source": "/old-path",
      "destination": "/new-path"
    }
  ]
}
```

Consultez [Redirections](/fr/create/redirects) pour plus d'informations.

<div id="frequently-asked-questions">
  ## Questions fréquemment posées
</div>

<AccordionGroup>
  <Accordion title="Dois-je utiliser des chemins relatifs à la racine ou des URLs absolues pour les liens internes ?">
    Les chemins relatifs à la racine (commençant par `/`) sont le choix le plus courant pour les liens internes dans Mintlify. Ils fonctionnent de manière cohérente quel que soit l'emplacement de la page source dans votre répertoire, et ils ne se cassent pas si votre domaine de documentation change. Les URLs absolues pour les liens internes créent une fragilité inutile.

    Vous pouvez utiliser des chemins relatifs (`./` et `../`), mais comme ils sont résolus en fonction de l'emplacement du fichier source, ils peuvent se casser plus fréquemment.
  </Accordion>

  <Accordion title="Comment maintenir les liens d'ancrage stables lorsque je mets à jour les titres ?">
    Utilisez des IDs d'ancrage personnalisés pour les titres vers lesquels vous liez fréquemment. Ajouter `{#custom-id}` à un titre découple l'ancrage du texte du titre, afin que vous puissiez mettre à jour le texte du titre sans casser les liens qui pointent vers lui. C'est particulièrement utile pour les titres dans les sections de référence à fort trafic où le texte peut nécessiter des ajustements au fil du temps.
  </Accordion>

  <Accordion title="Que se passe-t-il avec les liens mis en favoris lorsque je réorganise ma documentation ?">
    Sans redirections, les liens mis en favoris et partagés deviennent des erreurs 404. Configurez des redirections dans votre `docs.json` chaque fois que vous déplacez ou renommez une page. Les redirections sont peu coûteuses à ajouter et évitent une mauvaise expérience utilisateur pour quiconque a lié vers votre documentation depuis une source externe—articles de blog, réponses Stack Overflow, wikis internes.
  </Accordion>

  <Accordion title="Combien de liens internes une page devrait-elle contenir ?">
    Liez lorsqu'un concept connexe est véritablement utile à l'utilisateur à ce moment précis—pas pour atteindre un quota. Trop peu de liens laissent les utilisateurs sans contexte ni prochaines étapes. Trop de liens transforment la page en un exercice de navigation qui éloigne les utilisateurs de ce qu'ils essaient de faire. En règle générale, liez la première mention d'un concept ou d'un outil, et ne répétez pas le même lien plusieurs fois sur une seule page.
  </Accordion>
</AccordionGroup>

<div id="related-resources">
  ## Ressources connexes
</div>

* [Formater le texte](/fr/create/text) : Options de formatage Markdown incluant les IDs de titres et le comportement des ancrages.
* [Navigation](/fr/organize/navigation) : Configurez la structure de votre documentation.
* [Redirections](/fr/create/redirects) : Configurez des redirections pour le contenu déplacé.