---
title: Tutoriel complet
description: D'un dépôt vide à un site de documentation en ligne — créez un projet, prévisualisez localement, déployez et configurez un domaine personnalisé.
---

Passez d'un dépôt vide à un site de documentation en ligne. Ajoutez un domaine personnalisé quand vous êtes prêt, et ignorez les étapes déjà effectuées.

## Prérequis

- Un compte GitHub
- Un dépôt contenant votre documentation (ou utilisez le [Modèle de démarrage](https://github.com/jamdesk/starter-docs))
- Node.js 20+ si vous souhaitez installer le CLI avec npm

<Steps>
  <Step title="Créer un projet et connecter GitHub">
    Créez votre premier projet dans le dashboard Jamdesk et connectez un dépôt.

    - Suivez [Créer des projets](/fr/setup/creating-projects) pour définir le nom, le slug et le chemin de la documentation
    - Si vous y êtes invité, installez l'application GitHub et accordez l'accès au dépôt ([Connexion à GitHub](/fr/setup/connecting-github))
  </Step>

  <Step title="Modifier et prévisualiser des pages avec le CLI">
    Utilisez le CLI Jamdesk pour prévisualiser vos modifications de pages avant de les pousser vers GitHub.

    <Tabs>
      <Tab title="npm">
        ```bash
        npm install -g jamdesk
        cd your-docs
        jamdesk dev
        ```
      </Tab>
      <Tab title="npx">
        ```bash
        cd your-docs
        npx jamdesk dev
        ```
      </Tab>
    </Tabs>

    Votre preview locale est disponible sur **http://localhost:3000**. En savoir plus dans [Preview locale](/fr/development/local-preview).

    Ouvrez une page `.mdx` dans votre éditeur, enregistrez une modification, puis rafraîchissez la preview locale. Lorsque le résultat vous convient, publiez-le via le workflow Git décrit à l'étape suivante.
  </Step>

  <Step title="Déployer en poussant vers GitHub">
    Chaque push vers votre branche configurée déclenche un build et publie sur votre sous-domaine Jamdesk.

    ```bash
    git add .
    git commit -m "Add docs content"
    git push origin main
    ```

    Remplacez `main` par la branche configurée dans votre projet si vous en utilisez une différente.

    Une fois le build terminé, votre documentation est en ligne sur `your-project.jamdesk.app`. Consultez [Déploiement](/fr/development/deployment) pour plus de détails.
  </Step>

  <Step title="Facultatif : Ajouter un domaine personnalisé">
    Rendez votre documentation prête pour la production avec votre propre domaine, lorsque vous êtes prêt à l'utiliser en dehors du sous-domaine Jamdesk.

    1. Accédez à **Paramètres** → **Domaines** dans le dashboard Jamdesk
    2. Ajoutez votre domaine (par exemple, `docs.example.com`)
    3. Créez les enregistrements DNS indiqués dans le dashboard
    4. Attendez la vérification et l'activation du SSL

    Pour le dépannage, consultez [Domaines personnalisés](/fr/deploy/custom-domains).
  </Step>
</Steps>

## Valider le flux complet

- Votre sous-domaine Jamdesk se charge et affiche le dernier build
- La preview locale reflète le même contenu et la même navigation
- Si configuré, le domaine personnalisé est vérifié et sert le contenu en HTTPS
- L'historique des builds affiche le dernier commit et l'attribution à l'auteur

## Facultatif : Héberger sur /docs

Si vous souhaitez que la documentation soit accessible sur un sous-chemin comme `example.com/docs`, consultez [Présentation du déploiement](/fr/deploy/overview) et [Hébergement sur sous-chemin](/fr/deploy/subpath-hosting).

## Et maintenant ?

<Columns cols={2}>
  <Card title="Créer un projet" icon="plus" href="/fr/setup/creating-projects">
    Gérer les paramètres et les modèles de projet
  </Card>
  <Card title="Présentation du CLI" icon="terminal" href="/fr/cli/overview">
    Installer le CLI et découvrir les commandes disponibles
  </Card>
  <Card title="Présentation du déploiement" icon="cloud-arrow-up" href="/fr/deploy/overview">
    Comparer les options d'hébergement
  </Card>
  <Card title="Domaines personnalisés" icon="globe" href="/fr/deploy/custom-domains">
    Vérifier le DNS et résoudre les problèmes de configuration
  </Card>
</Columns>