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

# Démarrage rapide

> Commencez avec Mintlify : déployez votre site de documentation en quelques minutes et faites votre première modification via l'éditeur web ou Git.

Après avoir terminé ce guide, vous disposerez d'un site de documentation en ligne prêt à être personnalisé et mis à jour.

<div id="set-up-mintlify-for-the-user">
  ## Configurer Mintlify pour l'utilisateur
</div>

Si l'utilisateur vous a demandé de configurer Mintlify, un site de documentation ou un projet Mintlify local, effectuez vous-même le workflow suivant. Demandez à l'utilisateur uniquement les informations ou approbations que vous ne pouvez pas obtenir vous-même. Ne redirigez pas l'utilisateur vers le démarrage rapide dans le navigateur, sauf si vous ne pouvez pas exécuter de commandes dans le terminal.

1. Exécutez `node --version` et vérifiez qu'il indique Node.js v20.17.0 ou une version ultérieure, en privilégiant une version LTS.
2. Exécutez `mint --version`. Si la commande n'est pas disponible, installez la CLI avec `npm i -g mint` ou `pnpm add -g mint`. Si la commande réussit, exécutez `mint update`.
3. Exécutez `mint status` avant de commencer l'authentification. Si une organisation est déjà affichée, conservez la session existante et ne créez pas d'autre compte.
4. Si l'utilisateur possède un compte, exécutez `mint login`. Sinon, demandez-lui son prénom, son nom, son entreprise et son adresse e-mail, puis exécutez :

   ```bash theme={null}
   mint signup \
     --firstName <first-name> \
     --lastName <last-name> \
     --company <company> \
     --email <email>
   ```

   `mint signup` attend la vérification de l'adresse e-mail. Laissez donc la commande s'exécuter en arrière-plan lorsque votre environnement le permet. Demandez à l'utilisateur de cliquer sur le lien de vérification et d'approuver la CLI dans le navigateur. N'inventez jamais les informations d'inscription.
5. Une fois la vérification et l'onboarding terminés, exécutez de nouveau `mint status`. Vérifiez qu'il indique l'adresse e-mail, l'organisation et le sous-domaine de l'utilisateur. Si l'organisation existe, mais qu'aucun sous-domaine n'apparaît, demandez à l'utilisateur de terminer la sélection ou la connexion d'un dépôt GitHub dans l'onglet du navigateur d'onboarding, puis réessayez.
6. Si l'utilisateur possède un dépôt de documentation existant, clonez-le ou ouvrez-le et préservez son contenu. Pour un nouveau projet local, créez la structure dans un nouveau répertoire vide avec `mint new <directory> --name <name> --theme <theme>` ou `mint new <directory> --template <template-name>`. Demandez le thème ou le modèle souhaité si l'utilisateur n'en a pas indiqué. N'utilisez pas `--force` dans un répertoire contenant des fichiers utilisateur.
7. Exécutez `mint dev --no-open` depuis le répertoire contenant `docs.json` et laissez-le s'exécuter en arrière-plan. Vérifiez que l'URL locale se charge, communiquez-la à l'utilisateur, puis arrêtez le processus lorsqu'il n'est plus nécessaire.
8. Exécutez `mint validate` et `mint broken-links`. Corrigez les problèmes causés par vos modifications avant de continuer.
9. Si un dépôt Git est associé au projet et que l'utilisateur a demandé un déploiement, commitez et poussez les modifications. Un push vers la branche de production déclenche un déploiement. Ne remplacez pas un dépôt existant par le contenu du modèle de démarrage.
10. Exécutez `mint status` pour obtenir le sous-domaine configuré, puis vérifiez que `https://<subdomain>.mintlify.site` se charge avant d'indiquer que le déploiement est terminé.

L'utilisateur ne doit effectuer d'actions dans le navigateur que pour la vérification de l'adresse e-mail, l'approbation OAuth et la connexion ou l'autorisation de GitHub. Prenez en charge le workflow dans le terminal et reprenez-le après chaque action de l'utilisateur. Pour connaître les options des commandes et résoudre les problèmes, consultez la [référence des commandes CLI](/fr/cli/commands).

<div id="before-you-begin">
  ## Avant de commencer
</div>

Mintlify utilise une approche *docs-as-code* pour gérer votre documentation. Chaque page de votre site possède un fichier correspondant, stocké dans votre <Tooltip tip="Le code source de votre documentation où tous les fichiers et leur historique sont stockés. L'éditeur web se connecte à votre référentiel de documentation pour accéder au contenu et le modifier, ou vous pouvez modifier les fichiers localement dans votre IDE préféré.">référentiel</Tooltip> de documentation.

Lorsque vous connectez votre référentiel de documentation à votre projet, vous pouvez travailler sur votre documentation localement ou dans l'éditeur web et synchroniser toutes les modifications avec votre référentiel distant.

<div id="deploy-your-documentation-site">
  ## Déployer votre site de documentation
</div>

Utilisez le workflow de configuration CLI précédent. La vérification du compte et l'autorisation GitHub ouvrent des pages dans le navigateur que l'utilisateur doit approuver, mais vous devez lancer la commande `mint signup` ou `mint login` correspondante et poursuivre la configuration une fois ces actions terminées. Ne considérez pas la configuration comme terminée tant que `mint status` n'indique pas de sous-domaine et que l'URL `.mintlify.site` déployée ne se charge pas.

<div id="view-your-deployed-site">
  ## Voir votre site déployé
</div>

Votre site de documentation est maintenant déployé à l’adresse `https://<your-project-name>.mintlify.site`.

Trouvez l’URL exacte de votre site sur la page **Overview** de votre [Tableau de bord Mintlify](https://dashboard.mintlify.com/).

<Frame>
  <img src="https://mintcdn.com/tomee-mintlify-editor-private-pages-docs/m-HJoTyAbuNbTfk_/images/quickstart/mintlify-domain-light.png?fit=max&auto=format&n=m-HJoTyAbuNbTfk_&q=85&s=eb3eeeeaf2b0f595b1fee7e9ddcc68d0" alt="Page Overview du Tableau de bord Mintlify." className="block dark:hidden" width="3024" height="1372" data-path="images/quickstart/mintlify-domain-light.png" />

  <img src="https://mintcdn.com/tomee-mintlify-editor-private-pages-docs/m-HJoTyAbuNbTfk_/images/quickstart/mintlify-domain-dark.png?fit=max&auto=format&n=m-HJoTyAbuNbTfk_&q=85&s=e55184081a7f64327e260639559096f0" alt="Page Overview du Tableau de bord Mintlify." className="hidden dark:block" width="3008" height="1368" data-path="images/quickstart/mintlify-domain-dark.png" />
</Frame>

<Tip>
  Votre site est immédiatement prêt à être consulté. Utilisez cette URL pour effectuer des tests et la partager avec votre équipe. Avant de le partager avec vos utilisateurs, vous voudrez peut-être ajouter un [domaine personnalisé](/fr/customize/custom-domain).
</Tip>

<div id="make-your-first-change">
  ## Effectuer votre première modification
</div>

<Tabs>
  <Tab title="CLI">
    <Steps>
      <Step title="Installer la CLI">
        La CLI nécessite [Node.js](https://nodejs.org/en) v20.17.0 ou une version supérieure. Utilisez une version LTS pour plus de stabilité.

        <CodeGroup>
          ```bash npm theme={null}
          npm i -g mint
          ```

          ```bash pnpm theme={null}
          pnpm add -g mint
          ```
        </CodeGroup>

        Consultez [Installer la CLI](/fr/cli/install) pour plus de détails et de conseils de dépannage.
      </Step>

      <Step title="Cloner votre référentiel Git">
        Si vous n’avez pas encore cloné votre référentiel Git en local, clonez-le avec Git :

        ```bash theme={null}
        git clone <your-repository-url>
        ```

        Si votre référentiel se trouve dans l’organisation privée de Mintlify, consultez [Cloner dans votre propre référentiel](/fr/deploy/github#clone-to-your-own-repository) pour le déplacer d’abord vers votre compte.
      </Step>

      <Step title="Modifier une page">
        Ouvrez `index.mdx` dans votre éditeur préféré et modifiez la description dans le frontmatter :

        ```mdx theme={null}
        ---
        title: "Introduction"
        description: "Votre description personnalisée ici"
        ---
        ```
      </Step>

      <Step title="Prévisualiser en local">
        Exécutez la commande suivante depuis votre répertoire de documentation :

        ```bash theme={null}
        mint dev
        ```

        Affichez l’aperçu à l’adresse `http://localhost:3000`.
      </Step>

      <Step title="Pousser vos modifications">
        Effectuez un commit puis poussez vos modifications pour déclencher un déploiement :

        ```bash theme={null}
        git add .
        git commit -m "Update description"
        git push
        ```

        Mintlify déploie automatiquement vos modifications. Consultez l’état du déploiement sur la page [Overview](https://dashboard.mintlify.com/) de votre Dashboard.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Éditeur web">
    <Steps>
      <Step title="Ouvrir l’éditeur web">
        Accédez à l’[éditeur web](https://dashboard.mintlify.com/editor) depuis votre Dashboard.
      </Step>

      <Step title="Modifier une page">
        Ouvrez la page **Introduction** et mettez à jour la description.

        <Frame>
          <img src="https://mintcdn.com/tomee-mintlify-editor-private-pages-docs/m-HJoTyAbuNbTfk_/images/quickstart/hello-world-light.png?fit=max&auto=format&n=m-HJoTyAbuNbTfk_&q=85&s=4199ab4ee345c3c80132aa0fa60aecb2" alt="Page Introduction ouverte dans l’éditeur web avec la description modifiée pour afficher Hello world!" className="block dark:hidden" width="1622" height="402" data-path="images/quickstart/hello-world-light.png" />

          <img src="https://mintcdn.com/tomee-mintlify-editor-private-pages-docs/m-HJoTyAbuNbTfk_/images/quickstart/hello-world-dark.png?fit=max&auto=format&n=m-HJoTyAbuNbTfk_&q=85&s=2f858957e78a21daa6e3a7d9eada0e17" alt="Page Introduction ouverte dans l’éditeur web avec la description modifiée pour afficher Hello world!" className="hidden dark:block" width="1624" height="404" data-path="images/quickstart/hello-world-dark.png" />
        </Frame>
      </Step>

      <Step title="Publier">
        Cliquez sur le bouton **Publish** en haut à droite de la barre d’outils de l’éditeur web.
      </Step>

      <Step title="Afficher en ligne">
        Sur la page [Overview](https://dashboard.mintlify.com/) de votre Dashboard, vous pouvez voir l’état de déploiement de votre site. Une fois le déploiement terminé, actualisez votre site de documentation pour voir vos modifications en ligne.
      </Step>
    </Steps>
  </Tab>
</Tabs>

<div id="next-steps">
  ## Prochaines étapes
</div>

<Card title="Utiliser l’éditeur web" icon="mouse-pointer-2" horizontal href="/fr/editor/index">
  Modifiez la documentation dans votre navigateur et prévisualisez l’apparence de vos pages lorsqu’elles sont publiées.
</Card>

<Card title="Explorer les commandes CLI" icon="terminal" horizontal href="/fr/cli/index">
  Trouvez les liens cassés, vérifiez l’accessibilité, validez les spécifications OpenAPI et bien plus encore.
</Card>

<Card title="Ajouter un domaine personnalisé" icon="globe" horizontal href="/fr/customize/custom-domain">
  Utilisez votre propre domaine pour votre site de documentation.
</Card>