`.
* 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`.
## Documentation au survol
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.
## Atteindre la définition
Maintenez
CMD (macOS) ou
CTRL (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.
## Repli de code
Utilisez les chevrons de la gouttière pour replier des régions d'une page :
* Les régions de balises de composants et HTML, comme `
…`.
* Les sections de titres.
* Le frontmatter.
* Les blocs de code.
* Les commentaires JSX.
## Validation de la configuration
L'extension valide `docs.json` par rapport au [schéma Mintlify](https://mintlify.com/docs.json).
## Prévisualisation dans votre éditeur
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.
La barre d'outils de la prévisualisation comporte des boutons précédent, suivant et recharger, une zone d'adresse et un bouton bascule **Follow editor**. Saisissez un chemin comme `/quickstart` dans la zone d'adresse et appuyez sur
Entrée pour accéder à cette page. Avec **Follow editor** activé, la prévisualisation change de page à mesure que vous changez de fichier dans votre éditeur.
La prévisualisation dans l'éditeur s'affiche dans une iframe, donc la recherche du navigateur et les outils de développement ne peuvent pas y accéder. Sélectionnez le bouton **Open in browser** dans la barre d'outils de la prévisualisation, ou exécutez **Mintlify: Open preview in browser**, pour ouvrir la page dans votre navigateur.
Les prévisualisations dans l'éditeur nécessitent la [CLI Mintlify](/docs/fr/cli/install). Le serveur de prévisualisation s'exécute par défaut sur le port `3939` afin de ne pas entrer en conflit avec des applications sur le port 3000. Modifiez le port avec le paramètre `mintlify.preview.port`.
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**.
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.
## Encadrer du contenu dans des composants
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.
## Paramètres
| 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.followEditor` | `true` | Bascule la prévisualisation vers la page de l'éditeur actif lorsque vous changez de fichier. Également activable depuis la barre d'outils de la prévisualisation. |
| `mintlify.preview.port` | `3939` | Port du serveur de prévisualisation. Ajouté à la commande de prévisualisation via `--port`, sauf si cette commande en définit déjà un. |
`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.
## Commandes
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: Open preview in browser** | Ouvre la page prévisualisée dans votre navigateur. |
| **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. |
## Extensions en conflit
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).
## Dépannage
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**.
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.
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.
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.
## 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)