mintlify__docs/fr/quickstart.mdx

---
title: "Démarrage rapide"
description: "Commencez avec Mintlify : déployez votre site de documentation en quelques minutes et faites votre première modification via l'éditeur web ou Git."
keywords: ["démarrage rapide","déploiement","bien démarrer","premiers pas","didacticiel","configuration","prise en main"]
boost: 3
---

import SetupAgentPrompt from "/snippets/fr/setup-agent-prompt.mdx";

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

<Tip>
  Vous utilisez un agent d'IA ?

  Copiez l'invite suivante pour que votre agent configure votre site à votre place. Elle indique à votre agent de créer votre compte et de déployer votre site. Elle ajoute également la [skill](/fr/ai/skillmd) et le [serveur MCP](/fr/ai/model-context-protocol) Mintlify afin d'obtenir de meilleurs résultats lorsque vous mettez à jour votre contenu.

  L'invite divise le démarrage rapide en tâches que votre agent peut réaliser et lui indique de vous demander toute information dont il a besoin pendant la configuration.
</Tip>

<SetupAgentPrompt />

<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>

Accédez à [mintlify.com/start](https://mintlify.com/start) et suivez le processus d'onboarding. Pendant l'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'activer les déploiements automatiques.

Après l'onboarding, votre site de documentation est déployé et accessible via l'URL `.mintlify.site` de votre site.

<AccordionGroup>
  <Accordion title="Facultatif : ignorer la connexion d'un fournisseur Git pendant l'onboarding">
    Si vous souhaitez démarrer rapidement sans connecter votre propre référentiel, vous pouvez ignorer la connexion du fournisseur Git pendant l'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'utiliser immédiatement l'éditeur web. Si vous souhaitez utiliser votre propre référentiel plus tard, accédez à [Git Settings](https://app.mintlify.com/settings/deployment/git-settings) dans votre Dashboard pour migrer votre contenu à l'aide de l'assistant de configuration Git. Voir [Cloner dans votre propre référentiel](/fr/deploy/github#clone-to-your-own-repository) pour plus de détails.
  </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.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="/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/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
        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
        ---
        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 lorsqu’elles sont publiées.
</Card>

<Card title="Explorer les commandes CLI" icon="terminal" horizontal href="/fr/cli/index">
  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>