Éditeur web

Créez, mettez à jour et publiez votre documentation dans votre navigateur.

Accédez à l’éditeur web depuis votre Dashboard pour gérer votre documentation directement dans votre navigateur.

• Édition WYSIWYG : Modifiez votre documentation avec un éditeur WYSIWYG (What You See Is What You Get) qui affiche l’apparence de votre contenu une fois publié.
• Synchronisation Git : Toutes les modifications sont automatiquement synchronisées avec votre référentiel Git pour conserver l’historique des versions.
• Collaboration en équipe : Plusieurs personnes peuvent travailler simultanément sur la documentation.
• Intégration de composants : Ajoutez des encarts, des code blocks et d’autres composants avec des commandes au slash.
• Aucune configuration requise : Commencez à écrire immédiatement depuis votre Dashboard.

​

Aperçu

Voici comment vous travaillerez généralement dans l’éditeur web :

1. Choisissez votre branche

   Créez une branche ou apportez des modifications directement à votre branche de déploiement. Nous recommandons de créer une branche afin de pouvoir prévisualiser vos modifications avant leur mise en ligne.

2. Ouvrez votre fichier

   Accédez à un fichier existant dans la barre latérale ou créez-en un nouveau à l’aide de l’explorateur de fichiers.

3. Modifiez votre contenu

   Apportez des modifications dans l’éditeur web. Appuyez sur / pour ouvrir le menu des composants.

4. Prévisualisez vos modifications

   Le mode visuel vous montre comment vos modifications apparaîtront sur votre site en ligne. Utilisez-le pour vérifier que tout est correct.

5. Publiez vos modifications

   Publiez vos modifications directement sur votre site de documentation en ligne ou créez une pull request (demande de fusion) pour relire les modifications avant la fusion.

​

Modes de l’éditeur

L’éditeur web propose deux modes pour s’adapter à différentes préférences et besoins d’édition : le mode visuel et le Mode Markdown.

Utilisez l’interrupteur de mode dans la barre d’outils de l’éditeur pour changer de mode.

​

Mode visuel

Le mode visuel offre une expérience WYSIWYG (What You See Is What You Get) dans laquelle les modifications apportées dans l’éditeur reflètent l’apparence de votre documentation publiée. Ce mode est idéal lorsque vous souhaitez voir, en temps réel, à quoi ressembleront vos modifications.

​

Mode Markdown

Le mode Markdown offre un accès direct aux fichiers qui composent votre documentation. Ce mode est idéal lorsque vous avez besoin d’un contrôle précis sur les propriétés des composants ou lorsque vous préférez écrire en syntaxe MDX.

​

Gérer l’objet

​

Parcourir vos fichiers

Utilisez l’explorateur de fichiers dans la barre latérale pour parcourir vos fichiers de documentation. Cliquez sur n’importe quel fichier pour l’ouvrir dans l’éditeur.

Appuyez sur Commande + P sur macOS ou Ctrl + P sur Windows pour rechercher des fichiers par nom.

​

Créer de nouvelles pages

Sélectionnez l’icône Créer un nouveau fichier dans la barre latérale de l’explorateur de fichiers.

Les noms de fichiers sont automatiquement complétés par l’extension .mdx. Pour changer le type de fichier, cliquez sur l’extension. Sélectionnez le type de fichier souhaité dans le menu déroulant.

​

Renommer des pages

Pour renommer une page, cliquez sur l’icône du menu kebab du fichier que vous souhaitez renommer. Sélectionnez Renommer dans le menu déroulant.

​

Supprimer des pages

Pour supprimer une page, cliquez sur l’icône du menu kebab du fichier à supprimer. Sélectionnez Supprimer dans le menu déroulant.

​

Organisez votre navigation

Modifiez votre fichier docs.json pour ajouter de nouvelles pages et retirer de la navigation de votre site celles qui ont été supprimées. Consultez Navigation pour plus d’informations sur l’organisation des pages.

Exemple : ajouter une page Thèmes au groupe Profile

Dans cet exemple, vous avez créé une nouvelle page intitulée Thèmes et vous souhaitez l’ajouter au groupe Profile dans votre documentation. Ajoutez le chemin de la nouvelle page au tableau pages du groupe Profile dans votre fichier docs.json pour qu’elle apparaisse dans la navigation de votre site.

Adding a Themes page to the Profile group

{
    "navigation": {
        "groups": [
            {
                "group": "Premiers pas",
                "pages": [
                    "index",
                    "quickstart",
                    "installation"
                ]
            },
            {
                "group": "Profil",
                "pages": [
                    "settings",
                    "account-types",
                    "dashboard",
                    "themes"
                ]
            }
        ]
    }
}

​

Modifier le contenu

Apportez des modifications à vos pages à l’aide du mode visuel ou du mode Markdown dans l’éditeur.

En mode visuel, appuyez sur / pour ouvrir le menu des composants. Ajoutez des blocs de contenu, des encadrés, des blocs de code et d’autres composants pour personnaliser votre documentation.

En mode Markdown, vous pouvez modifier directement le MDX de vos pages. Cela peut être utile lorsque vous devez :

• Définir des propriétés spécifiques pour les composants
• Travailler avec des composants imbriqués complexes
• Copier et coller du contenu MDX à partir d’autres sources

Consultez Formater le texte et Formater le code pour plus d’informations sur la rédaction avec la syntaxe MDX.

​

Publier vos modifications

Le flux de publication de l’éditeur dépend de la branche sur laquelle vous travaillez et des règles de protection des branches de votre référentiel.

Type de branche	Protection de la branche	Résultat lors de la publication
Branche de déploiement	Aucune	Les modifications sont fusionnées et mises en ligne immédiatement
Branche de déploiement	Pull requests requises	Crée une pull request (demande de fusion) pour relecture
Autre branche	Aucune	Les modifications sont fusionnées dans la branche de déploiement et mises en ligne immédiatement
Autre branche	Pull requests requises	Crée une pull request (demande de fusion) pour relecture

Configurez des règles de protection des branches dans votre fournisseur Git pour exiger des revues de pull requests avant la fusion. Consultez About protected branches dans la documentation GitHub ou Protected branches dans la documentation GitLab pour en savoir plus.

Pour que vos commits soient signés avec votre compte GitHub, vous devez autoriser ce compte sur la page My profile de votre Dashboard. Si vous n’autorisez pas votre compte GitHub, la GitHub App de Mintlify signera les commits effectués dans l’éditeur web.

​

Pull requests et revue des modifications

Les pull requests (demandes de fusion) vous permettent de proposer des modifications depuis votre branche afin que d’autres puissent les examiner avant de les fusionner dans votre documentation en production. Cela aide à garantir l’exactitude de vos modifications et offre à votre équipe l’occasion de collaborer sur le contenu.

Même si vous travaillez seul, les pull requests sont utiles pour prévisualiser les modifications et maintenir un historique des mises à jour clair.

​

Créer une pull request

1. Enregistrer votre travail

   Sélectionnez Enregistrer les modifications pour enregistrer toutes les modifications sur votre branche.

2. Créer la pull request

   Sélectionnez Publish Pull Request dans la barre d’outils de l’éditeur.

3. Ajouter un titre et une description

   Rédigez un titre et une description clairs expliquant :

   • Les modifications que vous avez apportées
   • Pourquoi vous les avez apportées
   • Les points spécifiques à examiner
4. Créer et partager

   Sélectionnez Publish Pull Request. L’éditeur fournit un lien pour afficher votre pull request.

   

​

Examiner les pull requests

Une fois votre pull request créée :

1. Passer en revue les modifications : Vous et les membres de votre équipe pouvez examiner votre pull request dans votre fournisseur Git, comme GitHub ou GitLab.
2. Laisser des commentaires : Ajoutez des commentaires ou demandez des changements.
3. Apporter des modifications supplémentaires : Apportez des modifications supplémentaires dans l’éditeur web. Lorsque vous enregistrez les modifications, l’éditeur les envoie vers votre pull request.
4. Approuver : Approuvez la pull request lorsque vous êtes satisfait des changements.
5. Fusionner : Fusionnez la pull request lorsque vous êtes prêt à déployer vos changements en production.

​

Partager les déploiements de prévisualisation

Partagez des déploiements de prévisualisation avec votre équipe pour recueillir des avis avant de publier vos modifications.

1. Cliquez sur le bouton Share dans la barre d’outils de l’éditeur.

2. Cliquez sur le bouton Preview pour ouvrir le déploiement de prévisualisation dans un nouvel onglet du navigateur.

   

3. Partagez l’URL de prévisualisation avec toute personne qui doit revoir vos modifications.

Lorsque vous apportez des modifications, le déploiement de prévisualisation se met automatiquement à jour. Les changements peuvent mettre un court instant à apparaître.

Les URL de prévisualisation sont accessibles publiquement par défaut. Toute personne disposant du lien peut voir votre déploiement de prévisualisation. Pour restreindre l’accès aux membres authentifiés de votre organisation, activez l’authentification de prévisualisation dans votre Dashboard.

​

Raccourcis clavier

L’éditeur web prend en charge tous les raccourcis clavier courants comme copier, coller, annuler et tout sélectionner, ainsi que les raccourcis suivants :

Commande	macOS	Windows
Rechercher des fichiers	Cmd + P	Control + P
Ajouter un lien au texte sélectionné	Cmd + K	Control + K
Saut de ligne	Cmd + Enter	Control + Enter
Gras	Cmd + B	Control + B
Italique	Cmd + I	Control + I
Soulignement	Cmd + U	Control + U
Barré	Cmd + Shift + S	Control + Shift + S
Code	Cmd + E	Control + E
Texte normal	Cmd + Alt + 0	Control + Alt + 0
Titre 1	Cmd + Alt + 1	Control + Alt + 1
Titre 2	Cmd + Alt + 2	Control + Alt + 2
Titre 3	Cmd + Alt + 3	Control + Alt + 3
Titre 4	Cmd + Alt + 4	Control + Alt + 4
Liste numérotée	Cmd + Shift + 7	Control + Shift + 7
Liste à puces	Cmd + Shift + 8	Control + Shift + 8
Bloc de citation	Cmd + Shift + B	Control + Shift + B
Indice	Cmd + ,	Control + ,
Exposant	Cmd + .	Control + .

​

Dépannage

Trouvez des solutions aux problèmes courants que vous pouvez rencontrer lors de l’utilisation de l’éditeur web.

Les modifications n’apparaissent pas après la publication

Causes possibles :

• Le déploiement est toujours en cours
• Problèmes de cache du navigateur
• Erreurs de build ou de déploiement

Solutions :

1. Vérifiez l’état du déploiement dans votre Dashboard.

2. Forcez l’actualisation de votre navigateur (Ctrl

   ou Cmd

   )

3. Videz le cache de votre navigateur.

Erreurs d’autorisations lors de la publication

Causes possibles :

• Autorisations insuffisantes sur le référentiel Git
• Problèmes d’authentification avec votre fournisseur Git

Solutions :

1. Vérifiez que vous disposez des droits d’accès nécessaires au référentiel.
2. Vérifiez que votre intégration Git est correctement configurée.
3. Consultez la documentation Permissions de l’éditeur.

Problèmes de chargement de l’éditeur

Causes possibles :

• Problèmes de connectivité réseau
• Référentiels de documentation volumineux

Solutions :

1. Vérifiez votre connexion Internet.
2. Actualisez la page.
3. Contactez le support si le problème persiste.

Fichiers qui ne se chargent pas ou affichent des erreurs

Causes possibles :

• Syntaxe MDX invalide dans les fichiers
• Fichiers manquants ou corrompus
• Fichiers trop volumineux entraînant des expirations

Solutions :

1. Vérifiez la syntaxe du fichier pour détecter des erreurs de formatage MDX.
2. Vérifiez que le fichier existe dans votre référentiel.

​

Prochaines étapes

• Apprenez les concepts fondamentaux de Git
• Apprenez les bonnes pratiques pour collaborer avec les branches