Créer un projet
Créez un projet Jamdesk à partir d'un modèle ou connectez un dépôt GitHub. Votre site est en ligne sur yourproject.jamdesk.app en quelques minutes.
Avant d'écrire de la documentation, vous avez besoin d'un projet. Vous pouvez partir d'un modèle (Jamdesk crée le dépôt pour vous, sur GitHub ou Bitbucket Cloud) ou connecter un dépôt existant qui possède déjà un docs.json. Dans les deux cas, vous aurez un site en ligne en quelques minutes.
Créer un nouveau projet
Accédez à dashboard.jamdesk.com et connectez-vous avec votre compte GitHub.
Les nouveaux utilisateurs seront invités à autoriser l'application GitHub de Jamdesk.
Depuis le dashboard, cliquez sur New Project dans le coin supérieur droit.
Partez d'un modèle prédéfini. 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 modèle de démarrage 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é.
Définissez les informations de base de votre projet :
| Champ | Description |
|---|---|
| Name | Nom affiché dans le dashboard |
| Slug | Identifiant convivial pour l'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.mdxExemple 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
Une fois le projet créé, configurez-le dans Settings :
Général
- Name - Modifie le nom affiché
- Slug - Modifie l'identifiant du projet
- Delete Project - Supprime définitivement le projet
Dépôt
- Branch - Branche qui déclenche les déploiements
- Docs Path - Emplacement du
docs.jsonpour les monorepos
Domaine
- Subdomain - Votre URL
*.jamdesk.app - Custom Domain - Ajoutez votre propre domaine
- Host at a subpath - Servez la documentation à un chemin comme
/docsou/helpau lieu de la racine du site
Build
- Show Jamdesk Branding - Affiche le lien « Powered by Jamdesk » dans votre pied de page (activé par défaut)
- Rebuild - Déclenche manuellement un nouveau build
Les modifications des paramètres Build nécessitent un nouveau build pour prendre effet.
Limites du projet
Le plan Pro inclut un projet. Ajoutez-en avec les add-ons de projet à 15 $/mois chacun.