Démarrage rapide : déployer en 5 minutes
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.
Prérequis
Vous aurez besoin de :
- Un compte GitHub
- Un dépôt avec votre documentation (ou nous en créerons un)
Si vous migrez depuis Mintlify ou une autre plateforme de documentation, consultez le Guide de migration.
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 inclut du contenu exemple, une spécification OpenAPI, et des exemples de chaque composant pour que vous puissiez voir comment les choses fonctionnent avant de les remplacer par votre propre contenu.
Rendez-vous sur dashboard.jamdesk.com et inscrivez-vous avec GitHub.
Cliquez sur Nouveau projet → Depuis un modèle → Starter Docs.
Jamdesk crée un dépôt GitHub pour vous avec tout pré-configuré.
Votre documentation est déployée sur your-project.jamdesk.app. Modifiez les fichiers MDX, poussez, et le site se reconstruit automatiquement.
Vous pouvez aussi cloner le modèle de démarrage directement : git clone https://github.com/jamdesk/starter-docs.git my-docs
Option 2 : Connecter un dépôt existant
Vous avez déjà un dépôt avec de la documentation ? Connectez-le directement.
Rendez-vous sur dashboard.jamdesk.com et inscrivez-vous avec GitHub.
Cliquez sur Nouveau projet et connectez votre dépôt.
- Sélectionnez votre dépôt GitHub
- Choisissez la branche à déployer
- Jamdesk détecte votre
docs.jsonautomatiquement
Votre documentation est déployée sur your-project.jamdesk.app avec llms.txt généré automatiquement pour que les outils IA puissent lire votre documentation.
Chaque push sur votre branche connectée déclenche une reconstruction automatique.
Ce que contient un projet de documentation
Un projet Jamdesk minimal comporte deux éléments :
my-docs/
├── docs.json # Configuration
└── introduction.mdx # Your first page
docs.json
Le fichier de configuration qui définit votre site :
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Pages MDX
Les pages de documentation rédigées en MDX :
---
title: Introduction
description: Welcome to the docs
---
# Welcome
This is your first documentation page.Développement local (optionnel)
La CLI Jamdesk vous permet de prévisualiser les modifications localement avant de les pousser sur GitHub. Cela est utile pour détecter les erreurs de syntaxe MDX, mais ce n'est pas obligatoire.
Vous préférez ne rien installer ? Ignorez cette section. Modifiez vos fichiers MDX, validez et poussez—votre documentation se construira automatiquement.
Prévisualisez les modifications localement :
npm install -g jamdesk
cd my-docs
jamdesk devOuvrez http://localhost:3000 pour voir votre documentation avec rechargement à chaud.
Ajouter d'autres pages
- Créez un nouveau fichier MDX :
---
title: Getting Started
description: Learn the basics
---
Your content here...- Ajoutez-le à
docs.json:
{
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "getting-started"]
}
]
}
}- Poussez sur GitHub - votre nouvelle page se déploie automatiquement.
Domaine personnalisé
Ajoutez votre propre domaine dans Paramètres → Domaines :
- Entrez votre domaine (par ex.,
docs.example.com) - Ajoutez les enregistrements DNS indiqués
- Attendez la vérification (jusqu'à 48 heures)
Les certificats SSL sont provisionnés automatiquement. Guide complet →