---
title: "Démarrage rapide : Déployer en 5 minutes"
sidebarTitle: Démarrage rapide
description: Créez un site de documentation Jamdesk et déployez-le sur votre sous-domaine. Aucun outil de build requis—juste GitHub et deux fichiers.
---

Déployez un site de documentation avec seulement deux fichiers : `docs.json` et une page MDX. Choisissez l'option qui correspond à votre point de départ.

## Prérequis

Vous aurez besoin de :
- Un compte [GitHub](https://github.com)
- Un dépôt contenant votre documentation (ou nous en créerons un)

## Option 1 : Démarrer depuis le modèle de démarrage

La façon la plus rapide de commencer. Le [modèle de démarrage](https://github.com/jamdesk/starter-docs) inclut du contenu d'exemple, une spécification OpenAPI et des exemples de chaque composant, afin que vous puissiez voir comment les choses fonctionnent avant de les remplacer par votre propre contenu.

<Steps>
  <Step title="Créer un compte Jamdesk">
    Rendez-vous sur [dashboard.jamdesk.com](https://dashboard.jamdesk.com) et inscrivez-vous avec GitHub.
  </Step>

  <Step title="Créer un projet depuis le modèle">
    Cliquez sur **Nouveau projet** → **Depuis un modèle** → **Starter Docs**.

    Jamdesk crée un dépôt GitHub pour vous avec tout préconfiguré.
  </Step>

  <Step title="Votre site est en ligne">
    Votre documentation est déployée sur `votre-projet.jamdesk.app`. Modifiez les fichiers MDX, poussez, et le site se reconstruit automatiquement.
  </Step>
</Steps>

<Tip>
Vous pouvez aussi cloner le modèle de démarrage directement : `git clone https://github.com/jamdesk/starter-docs.git my-docs`
</Tip>

<Tip>
**Vous souhaitez garder certaines pages privées ?** Ajoutez `private: true` dans le frontmatter de n'importe quel fichier MDX, puis définissez un mot de passe dans **Project Settings** après le prochain build. Consultez [Contrôle d'accès](/fr/setup/access-control) pour les quatre options disponibles (public, mot de passe sur tout le site, mixte, SSO).
</Tip>

## Option 2 : Connecter un dépôt existant

Vous avez déjà un dépôt avec une documentation prête pour Jamdesk ? Connectez-le directement. Si vous migrez depuis Mintlify ou une autre plateforme de documentation, utilisez d'abord l'Option 3.

<Steps>
  <Step title="Créer un compte Jamdesk">
    Rendez-vous sur [dashboard.jamdesk.com](https://dashboard.jamdesk.com) et inscrivez-vous avec GitHub.
  </Step>

  <Step title="Créer un projet">
    Cliquez sur **Nouveau projet** et connectez votre dépôt.

    1. Sélectionnez votre dépôt GitHub
    2. Choisissez la branche à déployer
    3. Jamdesk détecte automatiquement votre `docs.json`

    Si votre dépôt n'a pas encore de `docs.json`, ajoutez le fichier minimal depuis [Contenu d'un projet de documentation](#qu-est-ce-qui-compose-un-projet-de-documentation) avant de le connecter.

    Pour les permissions du dépôt, la sélection de branche et les chemins de documentation, consultez [Connecter GitHub](/fr/setup/connecting-github).
  </Step>

  <Step title="Votre site est en ligne">
    Votre documentation est déployée sur `votre-projet.jamdesk.app` avec `llms.txt` généré automatiquement pour que les outils d'IA puissent lire votre documentation.

    Chaque push vers votre branche connectée déclenche une reconstruction automatique.
  </Step>
</Steps>

## Option 3 : Migrer depuis Mintlify ou une autre plateforme

Vous avez déjà une documentation sur Mintlify, GitBook, Docusaurus, ReadMe, Confluence ou une autre plateforme ? Commencez par le guide de migration avant de créer un nouveau projet. Il couvre la commande `jamdesk migrate` pour Mintlify et les étapes manuelles pour les autres outils de documentation. Après la migration, connectez le dépôt migré en utilisant l'[Option 2](#option-2-connecter-un-d-p-t-existant).

<Columns cols={2}>
  <Card title="Guide de migration" icon="right-left" href="/fr/setup/migration">
    Convertir une documentation Mintlify ou migrer manuellement depuis une autre plateforme
  </Card>
</Columns>

## Qu'est-ce qui compose un projet de documentation

Un projet Jamdesk minimal contient deux éléments :

```bash
my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page
```

Pour les sites plus importants, consultez [Structure des répertoires](/fr/setup/directory-structure) pour les dossiers recommandés, les ressources et les extraits de code.

### docs.json

Le fichier de configuration qui définit votre site :

```json
{
  "$schema": "https://jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction"]
      }
    ]
  }
}
```

Consultez la [Référence docs.json](/fr/config/docs-json-reference) pour toutes les options de configuration.

### Pages MDX

Les pages de documentation rédigées en MDX :

```mdx
---
title: Introduction
description: Welcome to the docs
---

# Welcome

This is your first documentation page.
```

Consultez [Bases du MDX](/fr/content/mdx-basics) pour le frontmatter, les titres, les liens et la syntaxe des composants.

## Développement local

Le CLI Jamdesk vous permet de prévisualiser les modifications localement avant de les pousser vers GitHub. Cela est utile pour détecter les erreurs de syntaxe MDX avant qu'elles n'atteignent votre site en production. Pour toutes les méthodes d'installation et les commandes, consultez la [présentation du CLI Jamdesk](https://jamdesk.com/docs/cli/overview).

Prévisualisez les modifications localement :

<Tabs>
  <Tab title="npm">
    ```bash
    npm install -g jamdesk
    cd my-docs
    jamdesk dev
    ```
  </Tab>
  <Tab title="Homebrew">
    ```bash
    brew tap jamdesk/tap
    brew install jamdesk
    cd my-docs
    jamdesk dev
    ```
  </Tab>
  <Tab title="npx">
    ```bash
    cd my-docs
    npx jamdesk dev
    ```
  </Tab>
</Tabs>

Ouvrez **http://localhost:3000** pour voir votre documentation avec rechargement à chaud.

## Ajouter d'autres pages

1. Créez un nouveau fichier MDX :

```mdx
---
title: Getting Started
description: Learn the basics
---

Your content here...
```

2. Ajoutez-le dans `docs.json` :

```json docs.json
{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}
```

3. Poussez vers GitHub — votre nouvelle page se déploie automatiquement.

Pour plus de modèles de liens, incluant les ancres et les cartes, consultez [Liens et navigation](/fr/content/links).

## Domaine personnalisé

Ajoutez votre propre domaine dans **Paramètres** → **Domaines** :

1. Saisissez votre domaine (par exemple, `docs.exemple.com`)
2. Ajoutez les enregistrements DNS affichés
3. Attendez la vérification (jusqu'à 48 heures)

Les certificats SSL sont provisionnés automatiquement. [Guide complet →](/fr/deploy/custom-domains)

## Besoin d'aide ?

Vous êtes bloqué ? Parcourez le [Centre d'aide](/fr/help/overview) pour des guides sur la configuration, la facturation et le dépannage. Ou contactez une vraie personne : ouvrez le widget de chat dans le coin inférieur de n'importe quelle page Jamdesk, ou envoyez-nous un e-mail à [support@jamdesk.com](mailto:support@jamdesk.com). Nous répondons rapidement.

## Et ensuite ?

<Columns cols={2}>
  <Card title="Tutoriel de bout en bout" icon="route" href="/fr/end-to-end-tutorial">
    Flux de travail complet de la configuration au domaine personnalisé
  </Card>
  <Card title="Bases du MDX" icon="file-code" href="/fr/content/mdx-basics">
    Rédiger de la documentation en MDX
  </Card>
  <Card title="Composants" icon="puzzle-piece" href="/fr/components/overview">
    Explorer les composants disponibles
  </Card>
  <Card title="Référence de configuration" icon="gear" href="/fr/config/docs-json-reference">
    Toutes les options docs.json
  </Card>
</Columns>