3. Comment modifier une page MDX simplement

Le guide clair pour comprendre et modifier vos pages Mintlify

Qu’est‑ce qu’un fichier MDX ?

Le MDX est un format qui combine Markdown et composants interactifs.

C’est le langage utilisé par Mintlify pour écrire vos pages de documentation.

Il permet d’ajouter du texte, des titres, des listes, des citations, des liens et même des composants avancés.

Modifier une page MDX revient simplement à modifier un fichier texte.

Où modifier une page MDX ?

Vous avez deux méthodes possibles :

1. Modifier directement dans l’éditeur Mintlify

C’est la méthode la plus simple pour les débutants.

Étapes :

• ouvrez votre projet Mintlify
• cliquez sur la page dans la sidebar
• modifiez le texte dans l’éditeur
• enregistrez
• cliquez sur Publish to GitHub pour mettre à jour votre site

Mintlify enverra automatiquement vos modifications dans votre dépôt GitHub.

2. Modifier le fichier MDX dans GitHub

Si vous préférez travailler directement dans GitHub :

Étapes :

• ouvrez votre dépôt GitHub
• allez dans le dossier contenant vos .mdx
• cliquez sur le fichier à modifier
• cliquez sur Edit
• modifiez le texte
• validez avec un commit

GitHub déclenchera automatiquement le déploiement sur Vercel.

Structure typique d’une page MDX

Une page MDX contient généralement :

• un titre principal
• des sous‑titres
• des paragraphes
• des listes
• éventuellement des composants Mintlify

Mintlify utilise automatiquement les titres #, ##, ###) pour créer la navigation interne.

Conseils pour bien modifier vos pages

• utilisez des titres clairs et cohérents
• évitez les séparateurs HTML comme <hr />
• gardez vos blocs simples pour éviter les erreurs
• testez vos modifications dans l’aperçu Mintlify
• faites des commits courts et explicites dans GitHub

Comment vérifier vos modifications ?

Après publication :

• ouvrez votre site sur Vercel
• rechargez la page modifiée
• vérifiez la mise en forme
• ajustez si nécessaire

Chaque modification MDX est visible en quelques secondes.

Résumé

Modifier une page MDX est simple :

vous éditez le fichier, vous publiez sur GitHub, et Vercel met automatiquement votre site à jour.

Pour aller plus loin

• Syntaxe MDX : https://mdxjs.com
• Documentation Mintlify : https://mintlify.com/docs