Démarrage rapide : Déployer en 5 minutes

Jamdesk est un logiciel de documentation qui publie un dépôt GitHub de Markdown sous forme de site de documentation hébergé, avec une sortie lisible par IA (llms.txt, des endpoints .md par page, et un serveur MCP) générée automatiquement.

Déployez un site de documentation avec seulement deux fichiers : docs.json et une page MDX. Choisissez le chemin correspondant à votre point de départ.

Prérequis

Vous aurez besoin de :

• Un compte GitHub
• Un dépôt contenant votre documentation (ou nous en créerons un)

Option 1 : Démarrer à partir du modèle de départ

La façon la plus rapide de démarrer. Le modèle de départ 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.

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.

Option 3 : Migrer depuis Mintlify ou une autre documentation

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.

Contenu d'un projet de documentation

Un projet Jamdesk minimal comporte deux éléments :

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

Pour des sites plus volumineux, consultez Structure des répertoires pour les dossiers, ressources et snippets recommandés.

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"]
      }
    ]
  }
}

Consultez la Référence docs.json pour toutes les options de configuration.

Pages MDX

Pages de documentation écrites en MDX :

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

# Welcome

This is your first documentation page.

Consultez Bases de MDX pour le frontmatter, les titres, les liens et la syntaxe des composants.

Développement local

Le CLI Jamdesk vous permet de prévisualiser les changements localement avant de pousser vers GitHub. C'est utile pour détecter les erreurs de syntaxe MDX avant qu'elles n'atteignent votre site en ligne. Pour toutes les méthodes d'installation et commandes, consultez l'aperçu du CLI Jamdesk.

Prévisualisez les changements localement :

npm install -g jamdesk
cd my-docs
jamdesk dev

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

Ajouter d'autres pages

1. Créez un nouveau fichier MDX :

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

Your content here...

2. Ajoutez-le à 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, y compris les ancres et les cartes, consultez Liens et navigation.

Domaine personnalisé

Ajoutez votre propre domaine dans Settings → Domains :

1. Entrez votre domaine (par exemple, docs.example.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 →

Besoin d'aide ?

Bloqué sur quelque chose ? Parcourez le Centre d'aide 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 écrivez-nous à support@jamdesk.com. Nous répondons rapidement.

Référence complète

Tout ce que vous pouvez construire et exécuter se trouve dans trois références : chaque composant MDX, chaque commande CLI, et chaque option de configuration docs.json.

Et ensuite ?