Créer un projet

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

Créer un nouveau projet

Se connecter à Jamdesk

Rendez-vous sur dashboard.jamdesk.com et connectez-vous avec votre compte GitHub.

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

Cliquer sur New Project

Depuis le dashboard, cliquez sur New Project en haut à droite.

Choisir un point de départ

Partez d'un template préconçu. Jamdesk crée un nouveau dépôt GitHub pour vous, avec du contenu d'exemple, une navigation et des composants déjà configurés.

Le Starter Template par défaut inclut des pages d'exemple, une spécification OpenAPI et des exemples de chaque composant. Remplacez le contenu par le vôtre, et c'est terminé.

Configurer les paramètres du projet

Définissez les informations de base de votre projet :

Champ	Description
Name	Nom d'affichage indiqué dans le dashboard
Slug	Identifiant compatible URL (par ex. `my-docs`)
Domain	Votre sous-domaine `*.jamdesk.app`

Structure minimale du dépôt

Un projet Jamdesk n'a besoin que d'un docs.json et d'au moins une page :

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

Exemple de docs.json :

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 Settings :

General

Name - Modifier le nom d'affichage
Slug - Changer l'identifiant du projet
Delete Project - Supprimer définitivement le projet

Repository

Branch - Quelle branche déclenche les déploiements
Docs Path - Emplacement du docs.json pour les monorepos

Domain

Subdomain - Votre URL *.jamdesk.app
Custom Domain - Ajouter votre propre domaine
Host at /docs - Servir la documentation sur le chemin /docs au lieu de la racine

Build

Show Jamdesk Branding - Afficher le lien « Powered by Jamdesk » dans votre footer (activé par défaut)
Rebuild - Déclencher manuellement un nouveau build

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

Limites de projets

Plan	Projects	Builds/Month
Free	1	100
Pro	10	Illimité
Team	Illimité	Illimité

Et ensuite ?

Connecter GitHub

Associez votre dépôt pour des builds automatiques

Structure des répertoires

Organisez votre documentation pour évoluer à grande échelle

Configuration du monorepo

Configurez le chemin de la documentation pour les monorepos

Tutoriel complet

Suivez le workflow complet de Jamdesk