mintlify__docs/fr/guides/linking.mdx

---
title: "Liens"
description: "Créez des liens internes, référencez des endpoints d'API et maintenez l'intégrité des liens dans votre documentation."
keywords: ["internal links", "cross-references", "anchor links", "broken links", "deep linking", "custom heading IDs"]
---

Un maillage de liens efficace crée une expérience de consultation de la documentation cohérente qui aide les utilisateurs à découvrir du contenu connexe et à naviguer efficacement. Un nombre excessif de liens ou des liens rompus peuvent dérouter les utilisateurs et rendre votre documentation moins efficace. Ce guide explique comment créer et maintenir des liens dans l'ensemble de votre documentation.

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

Créez des liens vers d’autres pages de votre documentation en utilisant des chemins relatifs à la racine. Ces chemins partent de la racine de votre répertoire de documentation et fonctionnent de manière cohérente, quel que soit l’emplacement des pages de lien dans votre répertoire.

```mdx
* [Guide de démarrage rapide](/quickstart)
* [Présentation de l'API](/api-playground/overview)
* [Composants personnalisés](/customize/react-components)
```

* [Guide de démarrage rapide](/fr/quickstart)
* [Présentation de l&#39;API](/fr/api-playground/overview)
* [Composants personnalisés](/fr/customize/react-components)

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

Les liens d’ancrage vous permettent de créer un lien direct vers des sections spécifiques d’une page. Chaque titre génère automatiquement un lien d’ancrage à partir de son texte.

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

Faites référence aux titres de la page actuelle à l’aide du symbole # :

```mdx
[Accéder aux bonnes pratiques](#best-practices)
```

[Passer aux bonnes pratiques](#best-practices)

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

Combinez les chemins de page avec des liens d&#39;ancrage.

```mdx
* [Personnalisez votre playground](/api-playground/overview#customize-your-playground)
* [Propriétés des cartes](/components/cards#properties)
```

* [Personnaliser votre espace de test](/fr/api-playground/overview#customize-your-playground)
* [Propriétés des cartes](/fr/components/cards#properties)

<div id="how-anchor-links-are-generated">
  ### Comment Mintlify génère les liens d’ancrage
</div>

Mintlify crée automatiquement les liens d’ancrage à partir du texte des en-têtes.

* Convertir en minuscules
* Remplacer les espaces par des tirets
* Supprimer les caractères spéciaux
* Conserver les chiffres et les lettres

| Texte de l’en-tête | Lien d’ancrage |
|-------------|-------------|
| `## Getting Started` | `#getting-started` |
| `### API Authentication` | `#api-authentication` |
| `#### Step 1: Install` | `#step-1-install` |

<Note>
  Les en-têtes avec la propriété `noAnchor` ne génèrent pas de liens d'ancrage. Pour plus de détails, consultez [Format text](/fr/create/text#disabling-anchor-links).
</Note>

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

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

```mdx
## Configuration options {#config}
```

Ce titre est accessible via `#config` au lieu de `#configuration-options`. Les IDs personnalisés sont utiles pour maintenir des liens d'ancrage stables lorsque vous modifiez le texte du titre. Consultez [Mettre en forme le texte](/fr/create/text#custom-heading-ids) pour plus de détails.

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

Les liens profonds pointent vers des états ou des emplacements spécifiques au sein d'une page, et non vers la page elle-même. Utilisez les liens profonds pour diriger les utilisateurs directement vers un accordéon ouvert ou une vue de l'API playground.

<div id="accordion-deep-links">
  ### Liens profonds vers les accordéons
</div>

Lorsqu'un utilisateur ouvre un accordéon, le hash de l'URL se met à jour pour refléter l'état ouvert. En visitant une URL avec ce hash, l'accordéon s'ouvre automatiquement et la page défile jusqu'à celui-ci.

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

```mdx
<Accordion title="Installation steps" id="install">
  ...
</Accordion>
```

Cet accordéon est accessible via `#install` au lieu du `#installation-steps` généré automatiquement.

Voir [Accordéons](/fr/components/accordions) pour plus d'informations.

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

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

```text
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 pour partager un lien direct vers le playground interactif d'un endpoint dans les conversations de support ou les flux d'intégration.

Voir [API playground](/fr/api-playground/overview#parameter-anchor-links) pour plus d'informations sur les liens d'ancrage des paramètres.

<div id="link-to-api-endpoints">
  ## Créer des liens vers des endpoints d'API
</div>

Lorsque vous documentez vos API, vous pouvez créer des liens vers des endpoints spécifiques depuis n'importe quel endroit de votre documentation.

Créez des liens vers les pages d'endpoints d'API en utilisant leur chemin dans la navigation.

<div id="link-to-external-pages">
  ## Liens vers des pages externes
</div>

Lorsque vous créez des liens vers des ressources externes, veillez à ce qu’il soit clair que le lien mène en dehors de votre documentation.

```mdx
En savoir plus sur la [syntaxe Markdown](https://www.markdownguide.org/) (lien externe).

Voir la [spécification OpenAPI](https://swagger.io/specification/) dans la documentation Swagger pour plus de détails.
```

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

<div id="write-descriptive-link-text">
  ### Rédigez un texte de lien descriptif
</div>

Utilisez un texte de lien clair et descriptif qui indique où un lien mène les utilisateurs.

<CodeGroup>
  ```mdx Bons exemples
  Voir [Pages cachées](/organize/hidden-pages) pour plus d’informations.
  [Configurer des domaines personnalisés](/customize/custom-domain)
  ```

  ```mdx À éviter
  [Cliquez ici](/api-playground/overview)
  [En savoir plus](/deploy/deployments)
  [Voir cette page](/customize/custom-domain)
  ```
</CodeGroup>

<div id="create-topic-clusters">
  ### Créer des regroupements thématiques
</div>

Reliez les contenus associés pour aider les utilisateurs à découvrir des informations pertinentes.

```mdx
## Sujets connexes

- [Authentification API](/api-playground/overview#authentication)
- [Ajout d'exemples SDK](/api-playground/adding-sdk-examples)
- [Gestion de la visibilité des pages](/api-playground/managing-page-visibility)
```

<div id="use-contextual-links">
  ### Utilisez des liens contextuels
</div>

Ajoutez des liens naturellement dans le contenu lorsqu’ils apportent une réelle valeur.

```mdx
To customize your documentation appearance, configure [themes](/customize/themes) 
and [fonts](/customize/fonts) in your settings. You can also add 
des [scripts personnalisés](/customize/custom-scripts) pour des fonctionnalités avancées.
```

<div id="link-to-prerequisites">
  ### Créer des liens vers les prérequis
</div>

Aidez les utilisateurs à se préparer en ajoutant des liens vers le contenu préalable :

```mdx
## Prérequis

Avant de déployer votre documentation, assurez-vous d'avoir :

- Terminé le [guide de démarrage rapide](/quickstart)
- Configuré votre [domaine personnalisé](/customize/custom-domain)
- Configuré l'[authentification](/deploy/authentication-setup) si nécessaire
```

<div id="avoid-circular-links">
  ### Évitez les liens circulaires
</div>

Ne créez pas de liens qui renvoient les utilisateurs indéfiniment entre les mêmes pages.

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

Utilisez l’interface en ligne de commande Mintlify (CLI) pour détecter les liens cassés dans votre documentation.

```bash
mint broken-links
```

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

Lorsque vous déplacez ou renommez des 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.
3. Recherchez dans votre documentation toutes 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 que tous les liens fonctionnent.

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

Lorsque vous déplacez définitivement du contenu, ajoutez des redirections pour éviter les liens cassés.

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

Voir [Redirections](/fr/create/redirects) pour en savoir plus.

<div id="related-resources">
  ## Ressources associées
</div>

* [Formater le texte](/fr/create/text): Apprenez-en plus sur le formatage Markdown.
* [Navigation](/fr/organize/navigation): Configurez la structure de votre documentation.
* [Redirections](/fr/create/redirects): Configurez des redirections pour le contenu déplacé.