Tutoriel complet
D'un dépôt vide à un site de documentation en ligne — créez un projet, prévisualisez localement, déployez et configurez un domaine personnalisé.
Passez d'un dépôt vide à un site de documentation en ligne. Ajoutez un domaine personnalisé quand vous êtes prêt, et ignorez les étapes déjà effectuées.
Prérequis
- Un compte GitHub
- Un dépôt contenant votre documentation (ou utilisez le Modèle de démarrage)
- Node.js 20+ si vous souhaitez installer le CLI avec npm
Créez votre premier projet dans le dashboard Jamdesk et connectez un dépôt.
- Suivez Créer des projets pour définir le nom, le slug et le chemin de la documentation
- Si vous y êtes invité, installez l'application GitHub et accordez l'accès au dépôt (Connexion à GitHub)
Utilisez le CLI Jamdesk pour prévisualiser vos modifications de pages avant de les pousser vers GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devVotre preview locale est disponible sur http://localhost:3000. En savoir plus dans Preview locale.
Ouvrez une page .mdx dans votre éditeur, enregistrez une modification, puis rafraîchissez la preview locale. Lorsque le résultat vous convient, publiez-le via le workflow Git décrit à l'étape suivante.
Chaque push vers votre branche configurée déclenche un build et publie sur votre sous-domaine Jamdesk.
git add .
git commit -m "Add docs content"
git push origin mainRemplacez main par la branche configurée dans votre projet si vous en utilisez une différente.
Une fois le build terminé, votre documentation est en ligne sur your-project.jamdesk.app. Consultez Déploiement pour plus de détails.
Rendez votre documentation prête pour la production avec votre propre domaine, lorsque vous êtes prêt à l'utiliser en dehors du sous-domaine Jamdesk.
- Accédez à Paramètres → Domaines dans le dashboard Jamdesk
- Ajoutez votre domaine (par exemple,
docs.example.com) - Créez les enregistrements DNS indiqués dans le dashboard
- Attendez la vérification et l'activation du SSL
Pour le dépannage, consultez Domaines personnalisés.
Valider le flux complet
- Votre sous-domaine Jamdesk se charge et affiche le dernier build
- La preview locale reflète le même contenu et la même navigation
- Si configuré, le domaine personnalisé est vérifié et sert le contenu en HTTPS
- L'historique des builds affiche le dernier commit et l'attribution à l'auteur
Facultatif : Héberger sur /docs
Si vous souhaitez que la documentation soit accessible sur un sous-chemin comme example.com/docs, consultez Présentation du déploiement et Hébergement sur sous-chemin.