Tutoriel complet
D'un dépôt vide à un site de documentation en ligne : créer un projet, prévisualiser en local, déployer et configurer 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à réalisées.
Prérequis
- Un compte GitHub
- Un dépôt contenant du contenu de 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 du projet, le slug et le chemin de la documentation
- Si demandé, installez l'application GitHub et accordez l'accès au dépôt (Connecter 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 prévisualisation locale s'exécute sur http://localhost:3000. En savoir plus dans Prévisualisation locale.
Ouvrez une page .mdx dans votre éditeur, enregistrez une modification, puis actualisez la prévisualisation locale. Quand le résultat vous convient, publiez-la avec le workflow Git à 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 branche différente.
Une fois le build terminé, votre documentation est en ligne à l'adresse your-project.jamdesk.app. Voir Déploiement pour plus de détails.
Servez votre documentation depuis votre propre domaine au lieu du sous-domaine Jamdesk.
- Allez dans Settings → Domains dans le dashboard Jamdesk
- Ajoutez votre domaine (par exemple,
docs.example.com) - Créez les enregistrements DNS affichés dans le dashboard
- Attendez que la vérification et le SSL soient terminés
Pour le dépannage, consultez Domaines personnalisés.
Valider le flux complet
- Votre sous-domaine Jamdesk se charge et affiche le dernier build
- La prévisualisation locale reflète le même contenu et la même navigation
- Si configuré, le domaine personnalisé est vérifié et sert en HTTPS
- L'historique des builds affiche le dernier commit et l'attribution de l'auteur
Facultatif : héberger sur /docs
Si vous souhaitez héberger la documentation sur un sous-chemin comme example.com/docs, consultez Vue d'ensemble du déploiement et Hébergement en sous-chemin.