Présentation de l'intégration
Complétez le flux d'intégration guidé pour configurer votre premier site de documentation — créez un projet, connectez GitHub, configurez docs.json et déclenchez votre premier build.
Les 5 étapes
Lors de votre première connexion, Jamdesk démarre automatiquement votre essai gratuit de 14 jours du plan Pro.
- Aucune carte de crédit requise
- Accès complet à toutes les fonctionnalités
- L'essai se termine 14 jours après l'activation
Donnez un nom à votre projet de documentation :
- Utilisez un nom clair et descriptif (par ex., « Documentation API », « Guide utilisateur »)
- Cela fait partie de l'URL de votre site de documentation
- Vous pouvez modifier le nom d'affichage ultérieurement dans les paramètres du projet
Jamdesk crée un nouveau dépôt GitHub à partir du Modèle de démarrage :
- Exemples de pages avec du contenu et des composants réalistes
docs.jsonpréconfiguré avec la navigation et l'image de marque- Exemple de spécification OpenAPI pour la documentation de référence API
- Prêt à modifier et à pousser immédiatement
Le CLI Jamdesk permet le développement local :
npm install -g jamdeskVous pouvez ignorer cette étape pendant l'intégration et installer le CLI à tout moment. Si vous l'ignorez, vous pouvez toujours modifier la documentation directement sur GitHub.
Vous êtes prêt à build ! Modifiez votre documentation :
- Via le CLI : Modifiez les fichiers localement avec
jamdesk dev - Via GitHub : Modifiez les fichiers
.mdxdirectement dans votre dépôt - Sur Jamdesk : Certaines fonctionnalités du dashboard sont disponibles (selon le plan)
Les modifications déclenchent automatiquement des rebuilds de la documentation lorsque vous poussez vers GitHub.
Après l'intégration
Une fois l'intégration terminée, vous pouvez :
- Créer des projets supplémentaires
- Inviter des membres de l'équipe
- Consulter les analytiques
- Configurer des domaines personnalisés
Dépannage
J'ai ignoré une étape, puis-je revenir en arrière ?
Vous pouvez terminer l'intégration à tout moment depuis le dashboard de votre projet. Recherchez la carte d'intégration pour reprendre là où vous vous êtes arrêté.
J'ai choisi le mauvais dépôt GitHub
Créez un nouveau projet avec le dépôt correct — vous pouvez supprimer l'ancien à tout moment.
J'ai besoin d'aide pendant l'intégration
Contactez le support à tout moment pendant le processus.
