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

# Extension Mintlify MDX

> Installez l'extension Mintlify MDX pour bénéficier de l'autocomplétion, des diagnostics en ligne, de la documentation au survol et d'une prévisualisation dans l'éditeur pendant que vous rédigez du MDX en local.

L'extension Mintlify MDX ajoute la prise en charge du langage pour les projets Mintlify à VS Code, Cursor, Devin Desktop et aux autres éditeurs compatibles avec l'API d'extensions de VS Code. L'extension connaît chaque composant intégré et chaque propriété, vous bénéficiez donc de l'autocomplétion pendant la saisie, et elle signale les composants inconnus, les propriétés invalides et les imports de snippets non résolus.

L'extension exécute également une prévisualisation en direct dans votre éditeur, ce qui vous permet de rédiger et de voir le rendu sans passer par un navigateur.

<div id="prerequisites">
  ## Prérequis
</div>

* VS Code 1.85.0 ou plus récent
* Un répertoire de documentation avec un fichier `docs.json` valide
* La [CLI Mintlify](/docs/fr/cli/install), uniquement pour la prévisualisation dans l'éditeur

<div id="install-the-extension">
  ## Installer l'extension
</div>

Installez depuis la ligne de commande :

```bash theme={null}
code --install-extension mintlify.mintlify-snippets
```

Ou installez depuis votre éditeur :

1. Ouvrez la vue Extensions.
2. Recherchez `@id:mintlify.mintlify-snippets`.
3. Cliquez sur **Install**.

Vous pouvez également l'installer depuis le [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).

L'extension s'active lorsque vous ouvrez un fichier `.mdx` ou un espace de travail contenant un fichier `docs.json`.

<div id="autocomplete">
  ## Autocomplétion
</div>

Tapez `<` pour afficher tous les composants intégrés. L'autocomplétion suggère les propriétés et les valeurs des composants à l'intérieur des balises.

L'extension suggère les composants que vous importez depuis des [snippets réutilisables](/docs/fr/create/reusable-snippets) aux côtés des composants intégrés.

<div id="diagnostics">
  ## Diagnostics
</div>

L'extension signale les problèmes dans le panneau Problèmes et les souligne dans votre fichier pendant que vous rédigez :

* Composants inconnus.
* Propriétés inconnues ou en double.
* Valeurs invalides pour les propriétés énumérées.
* Propriétés requises manquantes.
* Balises non fermées ou mal appariées.
* Imports de snippets non résolus.

Ces classes d'erreurs provoquent des échecs de build, corrigez-les donc au fil de la rédaction pour éviter des déploiements en échec.

Pour désactiver les diagnostics, définissez `mintlify.diagnostics.enabled` sur `false`.

<div id="hover-documentation">
  ## Documentation au survol
</div>

Survolez un composant ou une propriété pour voir sa fonction et un lien vers sa page dans la documentation Mintlify. Le survol d'un composant de snippet prévisualise le contenu du fichier de snippet.

<div id="go-to-definition">
  ## Atteindre la définition
</div>

Maintenez <kbd>CMD</kbd> (macOS) ou <kbd>CTRL</kbd> (Windows) et cliquez pour accéder à la définition :

* des composants de snippet ;
* des chemins d'import ;
* des attributs `href` et `src` qui pointent vers des pages locales.

L'extension trouve la racine de votre documentation en remontant depuis le fichier ouvert jusqu'à trouver `docs.json`, de sorte que les imports absolus comme `/snippets/example.mdx` se résolvent correctement. Le projet détecté apparaît dans la barre d'état. Pour vérifier quelle racine l'extension utilise, exécutez **Mintlify: Show detected docs root** depuis la palette de commandes.

<div id="configuration-validation">
  ## Validation de la configuration
</div>

L'extension valide `docs.json` par rapport au [schéma Mintlify](https://mintlify.com/docs.json).

<div id="preview-in-your-editor">
  ## Prévisualisation dans votre éditeur
</div>

Ouvrez un fichier `.mdx` et sélectionnez l'icône de prévisualisation dans la barre de titre de l'éditeur, ou faites un clic droit sur le fichier et sélectionnez **Preview Mintlify**. Un panneau de prévisualisation s'ouvre à côté de votre éditeur et affiche le rendu de la page.

Les prévisualisations dans l'éditeur nécessitent la [CLI Mintlify](/docs/fr/cli/install). L'URL du serveur en cours d'exécution apparaît dans la barre d'état. Sélectionnez-la pour arrêter le serveur, ou exécutez **Mintlify: Stop preview server**.

Pour voir la sortie du processus `mint dev` sous-jacent, ouvrez le canal de sortie **Mintlify Preview**.

<Tip>
  Utilisez la prévisualisation dans l'éditeur pendant que vous rédigez des pages individuelles, et [`mint dev`](/docs/fr/cli/preview) dans un navigateur lorsque vous voulez tester la navigation, la recherche ou l'authentification sur l'ensemble de votre site.
</Tip>

<div id="wrap-content-in-components">
  ## Encadrer du contenu dans des composants
</div>

L'extension inclut des snippets qui encadrent le texte sélectionné dans un composant, plutôt que d'insérer un composant vide à remplir.

Pour les utiliser, sélectionnez le contenu à encadrer, puis exécutez **Snippets: Surround With** depuis la palette de commandes et choisissez un composant. Des snippets sont disponibles pour `AccordionGroup`, `CardGroup`, `CodeGroup`, `Expandable`, `Frame`, `RequestExample`, `ResponseExample` et les blocs de code délimités.

<div id="settings">
  ## Paramètres
</div>

| Paramètre                                 | Valeur par défaut    | Description                                                                                                                           |
| ----------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `mintlify.diagnostics.enabled`            | `true`               | Signale les composants inconnus, les propriétés inconnues, les propriétés requises manquantes et les imports de snippets non résolus. |
| `mintlify.warnAboutConflictingExtensions` | `true`               | Avertit lorsqu'une autre extension MDX est installée aux côtés de l'extension Mintlify MDX.                                           |
| `mintlify.preview.command`                | `mint dev --no-open` | Commande utilisée pour démarrer le serveur de prévisualisation, exécutée depuis la racine de votre projet.                            |
| `mintlify.preview.followScroll`           | `true`               | Fait défiler la prévisualisation jusqu'au titre le plus proche du haut de votre éditeur.                                              |

`mintlify.preview.command` est un paramètre utilisateur, un espace de travail ne peut donc pas le remplacer. Cela empêche un dépôt cloné d'exécuter une commande arbitraire sur votre machine lorsque vous ouvrez une prévisualisation.

<div id="commands">
  ## Commandes
</div>

Exécutez-les depuis la palette de commandes :

| Commande                              | Description                                                  |
| ------------------------------------- | ------------------------------------------------------------ |
| **Mintlify: Preview Mintlify**        | Ouvre le panneau de prévisualisation pour le fichier actuel. |
| **Mintlify: Stop preview server**     | Arrête le serveur de prévisualisation en cours d'exécution.  |
| **Mintlify: Show detected docs root** | Affiche le fichier `docs.json` que l'extension a résolu.     |
| **Mintlify: Open component docs**     | Ouvre la documentation du composant sous votre curseur.      |
| **Mintlify: Restart language server** | Redémarre le serveur de langage.                             |

<div id="conflicting-extensions">
  ## Extensions en conflit
</div>

D'autres extensions MDX fournissent leur propre coloration syntaxique et leurs propres fonctionnalités de langage pour les fichiers `.mdx`, ce qui entre en conflit avec cette extension. Désactivez les autres extensions MDX pour éviter les suggestions en double et une coloration incohérente.

Pour le formatage du code, utilisez [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) aux côtés de cette extension ou exécutez [`mint format`](/docs/fr/cli/commands#mint-format).

<div id="troubleshooting">
  ## Dépannage
</div>

<AccordionGroup>
  <Accordion title="Les composants sont signalés comme inconnus">
    L'extension résout les composants par rapport à la racine de votre documentation. Exécutez **Mintlify: Show detected docs root** pour confirmer qu'elle a trouvé le bon fichier `docs.json`. Si la racine est incorrecte ou manquante, ouvrez le dossier contenant votre fichier `docs.json` comme espace de travail.

    Si la racine est correcte, exécutez **Mintlify: Restart language server**.
  </Accordion>

  <Accordion title="L'autocomplétion et la coloration se comportent de manière incohérente">
    Une autre extension MDX est probablement active elle aussi. Ouvrez la vue Extensions, recherchez `mdx` et désactivez toute autre extension MDX dans cet espace de travail.
  </Accordion>

  <Accordion title="La prévisualisation ne démarre pas">
    Ouvrez le canal de sortie **Mintlify Preview** pour voir l'erreur de `mint dev`.

    * `could not run "mint dev --no-open"` : la CLI n'est pas installée. Installez-la avec `npm i -g mint`.
    * `Trust the workspace first` : faites confiance à l'espace de travail via **Manage Workspace Trust**.
    * `no docs.json found above this file` : ouvrez le dossier contenant votre fichier `docs.json` comme espace de travail.
    * `Invalid docs.json` : exécutez [`mint validate`](/docs/fr/cli/commands#mint-validate) pour trouver l'erreur de configuration.
  </Accordion>

  <Accordion title="Les imports de snippets sont signalés comme non résolus">
    Les chemins d'import absolus se résolvent depuis la racine de votre documentation, pas depuis votre fichier. Vérifiez que le chemin correspond à l'emplacement du fichier de snippet par rapport à votre fichier `docs.json`, et que la racine détectée est correcte.
  </Accordion>
</AccordionGroup>


## Related topics

- [Installer la CLI](/docs/fr/cli/install.md)
- [Mintlify CLI](/docs/fr/cli/index.md)
- [Prévisualisation locale](/docs/fr/cli/preview.md)