Créer un projet

Avant de rédiger votre documentation, vous avez besoin d'un projet. Vous pouvez démarrer à partir d'un modèle (Jamdesk crée le dépôt GitHub pour vous) ou connecter un dépôt existant qui contient déjà un docs.json. Dans tous les cas, vous aurez un site en ligne en quelques minutes.

Créer un nouveau projet

Se connecter à Jamdesk

Accédez à dashboard.jamdesk.com et connectez-vous avec votre compte GitHub.

Les nouveaux utilisateurs seront invités à autoriser l'application GitHub Jamdesk.

Cliquer sur Nouveau projet

Depuis le dashboard, cliquez sur Nouveau projet en haut à droite.

Choisir un point de départ

Démarrez avec un modèle prédéfini. Jamdesk crée un nouveau dépôt GitHub pour vous avec du contenu, une navigation et des composants déjà configurés.

Le modèle Starter par défaut inclut des pages d'exemple, une spec OpenAPI et des exemples de chaque composant — remplacez le contenu par le vôtre et c'est prêt.

Configurer les paramètres du projet

Définissez les informations de base de votre projet :

Champ	Description
Nom	Nom affiché dans le dashboard
Slug	Identifiant compatible URL (ex. : `my-docs`)
Domaine	Votre sous-domaine `*.jamdesk.app`

Structure minimale du dépôt

Un projet Jamdesk nécessite uniquement un docs.json et au moins une page :

my-docs/
├── docs.json
└── introduction.mdx

Exemple de docs.json :

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

Paramètres du projet

Après la création, configurez votre projet dans Paramètres :

Général

Nom - Modifier le nom affiché
Slug - Changer l'identifiant du projet
Supprimer le projet - Supprimer définitivement le projet

Dépôt

Branche - La branche qui déclenche les déploiements
Chemin des docs - Emplacement de docs.json pour les monorepos

Domaine

Sous-domaine - Votre URL *.jamdesk.app
Domaine personnalisé - Ajouter votre propre domaine
Héberger à /docs - Servir la documentation au chemin /docs plutôt qu'à la racine

Build

Afficher la marque Jamdesk - Afficher le lien "Propulsé par Jamdesk" dans votre pied de page (activé par défaut)
Reconstruire - Déclencher manuellement un nouveau build

Les modifications des paramètres de build nécessitent un nouveau build pour prendre effet.

Limites des projets

Plan	Projets	Builds/mois
Free	1	100
Pro	10	Illimité
Team	Illimité	Illimité

Et ensuite ?

Connecter GitHub

Liez votre dépôt pour des builds automatiques

Structure des répertoires

Organisez votre documentation à grande échelle

Configuration monorepo

Configurer le chemin des docs pour les monorepos

Tutoriel complet

Suivre le workflow Jamdesk de bout en bout