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

# Pages

> Configurez les métadonnées, titres, descriptions, icônes et modes de mise en page via les propriétés YAML du frontmatter en haut de votre documentation MDX.

Chaque page est un fichier Markdown. Vous pouvez utiliser les types de fichiers `.mdx` ou `.md` pour vos pages. Nous recommandons d'utiliser MDX, qui combine Markdown avec des composants React pour créer une documentation riche et interactive. Le Markdown simple (`.md`) peut accélérer la migration depuis d'autres plateformes, mais passer à MDX permet de bénéficier de davantage de fonctionnalités.

<div id="page-metadata">
  ## Métadonnées de page
</div>

Chaque page commence par du frontmatter, les métadonnées YAML délimitées par `---` en haut d’un fichier. Ces métadonnées contrôlent l’apparence et le comportement de votre page.

Utilisez le frontmatter pour contrôler :

* Titres et descriptions de page
* Titres, icônes et tags de la barre latérale
* Mises en page des pages
* Balises méta SEO
* Métadonnées personnalisées

<ResponseField name="title" type="string">
  Le titre de votre page qui apparaît dans la navigation et les onglets du navigateur.

  S’il est omis, Mintlify génère un titre à partir du chemin. Le dernier segment du chemin devient le titre, avec les tirets et les traits de soulignement remplacés par des espaces et la première lettre mise en majuscule. Par exemple, `guides/getting-started.md` devient **Premiers pas**.
</ResponseField>

<ResponseField name="description" type="string">
  Une brève description du contenu de cette page. S’affiche sous le titre et améliore le SEO.
</ResponseField>

<ResponseField name="sidebarTitle" type="string">
  Un titre court affiché dans la navigation de la barre latérale.
</ResponseField>

<ResponseField name="icon" type="string">
  L’icône à afficher.

  Options :

  * Nom de l’[icône Font Awesome](https://fontawesome.com/icons)
  * Nom de l’[icône Lucide](https://lucide.dev/icons)
  * Nom de l’[icône Tabler](https://tabler.io/icons)
  * URL d’une icône hébergée en externe
  * Chemin vers un fichier d’icône dans votre projet
</ResponseField>

<ResponseField name="iconType" type="string">
  Uniquement pour les icônes [Font Awesome](https://fontawesome.com/icons). Le style de l’icône.

  Options : `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
</ResponseField>

<ResponseField name="tag" type="string">
  Un tag qui apparaît à côté du titre de votre page dans la barre latérale.
</ResponseField>

<ResponseField name="hidden" type="boolean">
  Définir sur `true` pour retirer la page de la navigation de la barre latérale. Les utilisateurs peuvent toujours accéder à la page via son URL, mais les moteurs de recherche ne l'indexent pas. Pour rendre une page visible à nouveau, supprimez entièrement ce champ. **Ne définissez pas** la valeur sur `false` car cela entraîne un comportement indéfini. Voir [Pages masquées](/fr/organize/hidden-pages) pour plus de détails.
</ResponseField>

<ResponseField name="noindex" type="boolean">
  Définir sur `true` pour empêcher les moteurs de recherche d’indexer la page. Voir [Désactiver l’indexation](/fr/optimize/seo#disable-indexing) pour plus de détails. Toutes les pages avec `hidden: true` dans leur frontmatter reçoivent automatiquement `noindex: true`.
</ResponseField>

<ResponseField name="boost" type="number">
  Multiplie le classement de la page dans la recherche intégrée par ce facteur. Utilisez des valeurs supérieures à `1` pour prioriser la page et des valeurs comprises entre `0` et `1` pour la dé-prioriser. Voir [Recherche](/fr/optimize/search#boost-search-ranking) pour plus de détails.
</ResponseField>

<ResponseField name="deprecated" type="boolean">
  Définir sur `true` pour afficher un libellé "obsolète" à côté du titre de la page. Utilisez ceci pour marquer du contenu obsolète ou des fonctionnalités héritées tout en gardant la page accessible.
</ResponseField>

<ResponseField name="hideFooterPagination" type="boolean">
  Définir sur `true` pour masquer les liens de navigation page précédente/page suivante en bas de la page. Utilisez cette option pour les pages autonomes telles que les pages de destination ou les pages de référence où la navigation séquentielle ne s'applique pas.
</ResponseField>

<ResponseField name="hideApiMarker" type="boolean">
  Définir sur `true` pour masquer le badge de méthode HTTP (tel que GET ou POST) à côté du titre de la page dans la barre latérale. Utilisez cette option pour les pages d'API lorsque vous souhaitez une apparence plus épurée de la barre latérale.
</ResponseField>

<ResponseField name="groups" type="string[]">
  Restreint la page aux utilisateurs appartenant à des groupes spécifiques. Les utilisateurs doivent appartenir à au moins un des groupes listés pour accéder à la page. Vous devez d'abord configurer l'[authentification](/fr/deploy/authentication-setup). Voir [Contrôler l'accès avec des groupes](/fr/deploy/authentication-setup#control-access-with-groups) pour plus d'informations.
</ResponseField>

<ResponseField name="<custom>" type="string">
  Tout frontmatter YAML valide. Par exemple, `product: "API"` ou `version: "1.0.0"`.
</ResponseField>

```yaml Example YAML frontmatter wrap theme={null}
---
title: "À propos du frontmatter"
description: "Le frontmatter correspond aux métadonnées qui contrôlent l'apparence et le comportement de votre page"
sidebarTitle: "Frontmatter"
icon: "book"
tag: "NOUVEAU"
---
```

<div id="page-mode">
  ## Mode de page
</div>

Contrôlez la mise en page de votre page avec le paramètre `mode`.

<div id="default">
  ### Par défaut
</div>

Si vous ne définissez aucun mode, la page utilise une mise en page standard avec une navigation dans la barre latérale et une table des matières.

```yaml theme={null}
---
title: "Titre de page par défaut"
---
```

<div id="wide">
  ### Large
</div>

Le mode large masque le panneau latéral, qui inclut la table des matières, les composants `<Panel>` ainsi que les exemples de requête et de réponse d’API. Utilisez ce mode pour les pages sans titres ou si vous souhaitez disposer d’un espace horizontal supplémentaire. Tous les thèmes prennent en charge le mode large.

```yaml theme={null}
---
title: "Titre de page large"
mode: "wide"
---
```

<div id="custom">
  ### Personnalisé
</div>

Le mode personnalisé offre une mise en page minimaliste et supprime tous les éléments à l’exception de la barre de navigation supérieure. Ce mode masque la barre latérale, la table des matières et le pied de page. Considérez le mode personnalisé comme une toile vierge pour créer des pages de destination (landing pages) ou des mises en page uniques avec une navigation réduite au minimum. Tous les thèmes prennent en charge le mode personnalisé.

```yaml theme={null}
---
title: "Titre de page personnalisé"
mode: "custom"
---
```

<Warning>
  La propriété `style` peut provoquer un décalage de la mise en page lors du chargement de la page. Privilégiez [Tailwind CSS ou un CSS personnalisé](/fr/customize/custom-scripts) pour éviter ce problème.
</Warning>

<div id="frame">
  ### Frame
</div>

Le mode Frame propose une mise en page proche du mode personnalisé, tout en conservant la navigation de la barre latérale. Ce mode de page permet d’utiliser du HTML et des composants personnalisés tout en préservant l’expérience de navigation par défaut. Les thèmes Aspen, Almond, Luma et Sequoia prennent en charge le mode Frame.

```yaml theme={null}
---
title: "Titre de la page Frame"
mode: "frame"
---
```

<div id="center">
  ### Centré
</div>

Le mode Centré supprime la barre latérale et la table des matières, et centre le contenu. Utilisez le mode Centré pour le journal des modifications ou d’autres pages où vous souhaitez mettre l’accent sur le contenu. Les thèmes Mint, Linden, Willow et Maple prennent en charge le mode Centré.

```yaml theme={null}
---
title: "Titre de page centré"
mode: "center"
---
```

<div id="api-pages">
  ## Pages d’API
</div>

Pour créer un bac à sable d’API interactif, ajoutez une spécification d’API dans votre frontmatter en définissant `api` ou `openapi`.

```yaml theme={null}
---
openapi: "GET /endpoint"
---
```

En savoir plus sur la création de la [documentation d’API](/fr/api-playground/overview).

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

Liez des sites externes directement depuis votre navigation avec la metadata `url`.

```yaml theme={null}
---
title: "Package npm"
url: "https://www.npmjs.com/package/mint"
---
```

<div id="search-engine-optimization">
  ## Optimisation pour les moteurs de recherche
</div>

Mintlify génère automatiquement la plupart des balises meta SEO. Vous pouvez définir manuellement des balises meta SEO pour personnaliser votre approche du SEO, le partage sur les réseaux sociaux et la compatibilité des navigateurs.

<Note>
  Encadrez toujours de guillemets les balises meta contenant des deux-points.
</Note>

```yaml theme={null}
---
"twitter:image": "/images/social-preview.jpg"
---
```

Consultez [SEO](/fr/optimize/seo) pour la liste complète des options de metadata SEO.

<div id="internal-search-keywords">
  ## Mots-clés de recherche internes
</div>

Aidez les utilisateurs à découvrir une page spécifique dans les résultats de recherche en ajoutant `keywords` dans vos metadata. Ces mots-clés n’apparaissent pas dans le contenu de la page. Si des utilisateurs recherchent ces mots-clés, la page s’affiche dans les résultats de recherche.

```yaml theme={null}
---
keywords: ['configuration', 'installation', 'premiers pas']
---
```

<div id="last-modified-timestamp">
  ## Horodatage de la dernière modification
</div>

Affichez la mention « Dernière modification le \[date] » sur toutes les pages en activant `metadata.timestamp` dans vos [paramètres globaux](/fr/organize/settings-seo#metadata).

```json docs.json theme={null}
"metadata": {
  "timestamp": true
}
```

Pour les déploiements adossés à GitHub ou GitLab, la date affichée correspond à celle du dernier commit git ayant modifié le fichier source de la page. Si aucune date de commit git n’est disponible, par exemple sur des déploiements qui ne sont pas connectés à GitHub ou GitLab, la date utilise par défaut l’horodatage du dernier déploiement.

Pour remplacer le paramètre global d’horodatage pour une page individuelle, utilisez le champ de frontmatter `timestamp`. Utilisez ce champ pour afficher ou masquer les horodatages sur des pages spécifiques.

```yaml theme={null}
---
title: "Titre de la page"
timestamp: false
---
```

Si vous définissez `timestamp: true`, la page affiche toujours l’horodatage même si le paramètre global est `false`. Si vous définissez `timestamp: false`, la page masque l’horodatage même si le paramètre global est `true`.