mintlify__docs/fr/quickstart.mdx

---
title: "Démarrage rapide"
description: "Déployez votre site de documentation et effectuez votre première modification."
keywords: ["démarrage rapide","déploiement","bien démarrer","premiers pas","didacticiel","configuration","prise en main"]
---

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

<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 déploiement Mintlify, vous pouvez travailler sur votre documentation localement ou dans l&#39;é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>

Accédez à [mintlify.com/start](https://mintlify.com/start) et suivez le processus d&#39;onboarding. Pendant l&#39;onboarding, vous connectez votre compte GitHub, créez ou sélectionnez un référentiel pour votre documentation et installez la GitHub App afin d&#39;activer les déploiements automatiques.

Après l&#39;onboarding, votre site de documentation est déployé et accessible via l&#39;URL `.mintlify.app` de votre site.

<AccordionGroup>
  <Accordion title="Facultatif : ignorer la connexion à GitHub pendant l'onboarding">
    Si vous souhaitez démarrer rapidement sans connecter votre propre référentiel, vous pouvez ignorer la connexion à GitHub pendant l&#39;onboarding. Mintlify crée un référentiel privé dans une organisation privée et configure automatiquement la GitHub App pour vous.

    Cela vous permet d&#39;utiliser immédiatement l&#39;éditeur web et de migrer vers votre propre référentiel plus tard.
  </Accordion>
</AccordionGroup>

<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.app`.

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

<Frame>
  <img src="/images/quickstart/mintlify-domain-light.png" alt="Page Overview du Tableau de bord Mintlify." className="block dark:hidden" />

  <img src="/images/quickstart/mintlify-domain-dark.png" alt="Page Overview du Tableau de bord Mintlify." className="hidden dark:block" />
</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
          npm i -g mint
          ```

          ```bash pnpm
          pnpm add -g mint
          ```
        </CodeGroup>

        Consultez [Installer la CLI](/fr/installation) 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, suivez les instructions dans [Cloner votre référentiel](/fr/installation#clone-your-repository).
      </Step>

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

        ```mdx
        ---
        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
        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
        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="/images/quickstart/hello-world-light.png" alt="Page Introduction ouverte dans l’éditeur web avec la description modifiée pour afficher Hello world!." className="block dark:hidden" />

          <img src="/images/quickstart/hello-world-dark.png" alt="Page Introduction ouverte dans l’éditeur web avec la description modifiée pour afficher Hello world!." className="hidden dark:block" />
        </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 une fois publiées.
</Card>

<Card title="Explorer les commandes CLI" icon="terminal" horizontal href="/fr/installation#additional-commands">
  Repérez les liens brisé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>