Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-doc-products-public-1774055462.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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. 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 de la page qui contient le lien. 
* [Guide de démarrage rapide](/quickstart)
* [Présentation de l'API](/api-playground/overview)
* [Composants personnalisés](/customize/react-components)
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.

​
Lier à des titres sur la même page

Faites référence aux titres de la page actuelle à l’aide du symbole # : 
[Accéder aux bonnes pratiques](#best-practices)
Passer aux bonnes pratiques Combinez les chemins de page avec des liens d’ancrage. 
* [Personnalisez votre playground](/api-playground/overview#customize-your-playground)
* [Propriétés des cartes](/components/cards#properties)
Les liens d’ancrage sont automatiquement créés à 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êteLien d’ancrage
## Getting Started#getting-started
### API Authentication#api-authentication
#### Step 1: Install#step-1-install
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.

​
Liens profonds

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. 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 est dérivé du title de l’accordéon. Utilisez la propriété id pour définir un hash personnalisé : 
<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 pour plus d’informations. Pour ouvrir l’API playground via un lien, ajoutez ?playground=open à l’URL de n’importe quelle page d’endpoint : 
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 pour plus d’informations sur les liens d’ancrage des paramètres. 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. 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. 
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.

​
Bonnes pratiques

​
Rédigez un texte de lien descriptif

Utilisez un texte de lien clair et descriptif qui indique où un lien mène les utilisateurs. 
Voir [Pages cachées](/organize/hidden-pages) pour plus d’informations.
[Configurer des domaines personnalisés](/customize/custom-domain)

​
Créer des regroupements thématiques

Reliez les contenus associés pour aider les utilisateurs à découvrir des informations pertinentes. 
## 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)
Ajoutez des liens naturellement dans le contenu lorsqu’ils apportent une réelle valeur. 
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.
Aidez les utilisateurs à se préparer en ajoutant des liens vers le contenu préalable : 
## 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
Ne créez pas de liens qui renvoient les utilisateurs indéfiniment entre les mêmes pages. Utilisez l’interface en ligne de commande Mintlify (CLI) pour détecter les liens cassés dans votre documentation. 
mint broken-links
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.

​
Utilisez des redirections pour le contenu déplacé

Lorsque vous déplacez définitivement du contenu, ajoutez des redirections pour éviter les liens cassés. 
{
  "redirects": [
    {
      "source": "/old-path",
      "destination": "/new-path"
    }
  ]
}
Voir Redirections pour en savoir plus.