Tutoriel de bout en bout
D’un dépôt vide à un site de doc en production : créez un projet, prévisualisez, déployez et configurez un domaine personnalisé si nécessaire.
Passez d'un dépôt vide à un site de documentation en production. Ajoutez un domaine personnalisé quand vous en avez besoin et ignorez les étapes déjà effectuées.
Prérequis
- Un compte GitHub
- Un dépôt avec du contenu de documentation (ou utilisez le Modèle de démarrage)
- Node.js 20+ si vous voulez installer le CLI avec npm
Créez votre premier projet dans le dashboard Jamdesk et connectez un dépôt.
- Suivez Création de projets pour définir le nom du projet, le slug et le chemin de documentation
- Si demandé, installez l'application GitHub et accordez l'accès au dépôt (Connexion à GitHub)
Utilisez le CLI Jamdesk pour prévisualiser les modifications de pages avant de les pousser vers GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devVotre preview locale s'exécute sur http://localhost:3000. En savoir plus dans Preview locale.
Ouvrez une page .mdx dans votre éditeur, enregistrez une modification et actualisez la preview locale. Quand le résultat vous convient, publiez avec le flux Git de 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 utilisez une autre branche.
Une fois le build terminé, votre documentation est accessible sur your-project.jamdesk.app. Voir Déploiement pour plus de détails.
Rendez votre documentation prête pour la production avec votre propre domaine quand vous êtes prêt à l'utiliser hors du sous-domaine Jamdesk.
- Allez dans Paramètres → Domaines dans le dashboard Jamdesk
- Ajoutez votre domaine (par exemple,
docs.example.com) - Créez les enregistrements DNS affichés dans le dashboard
- Attendez la vérification et la finalisation du SSL
Pour le dépannage, consultez Domaines personnalisés.
Valider le flux de bout en bout
- 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
- S'il est configuré, le domaine personnalisé est vérifié et sert le contenu en HTTPS
- L'historique des builds affiche le dernier commit et l'attribution de l'auteur
Optionnel : Héberger à /docs
Si vous souhaitez déployer votre documentation sur un sous-chemin comme example.com/docs, consultez Vue d'ensemble du déploiement et Hébergement en sous-chemin.