Déploiement

MarkDocs transforme votre collection de documents Markdown en une documentation fonctionnelle et prête à être déployée sur le service de votre choix. Par défaut, vous devrez la déployer manuellement à partir des fichiers générés dans un dossier temporaire qui vous est indiquée.

Tester localement le site

markdocs build --path="chemin de votre docs"
# MarkDocs va construire le projet situé à : chemin de votre docs
# Un dossier temporaire sera utilisé depuis l'emplacement : .../markdocs-temp-...
 
cd dossier-temporaire
npm run start

Déploiement manuel

Pour déployer manuellement votre documentation, vous aurez besoin de récupérer les fichiers dans le dossier temporaire. Le chemin est indiqué lors de la construction via la commande markdocs build.

• Copier et déplacez l’intégralité des fichiers et dossiers (hors node_modules) sur un serveur
• Retéléchargez les dépendances avec npm install sur le serveur
• Démarrer le projet avec npm run start
• Si tout fonctionne, vous pouvez laissez tourner le serveur en arrière plan avec PM2 : pm2 start npm --name 'markdocs-project' -- start

Déploiement automatique

Assurez-vous d’avoir le CLI de Vercel installé sur votre appareil : vercel --version. Si une erreur s’affiche, celui-ci n’est sûrement pas installé, vous pouvez l’installer avec npm install vercel --global.

Ensuite, utilisez markdocs create-vercel pour créer un nouveau projet sur votre compte Vercel et le lier automatiquement à votre projet. Un dossier caché .vercel sera ajouté dans votre projet et ne doit pas être partagé à un tier.

À chaque fois que vous exécuterez markdocs build, la docs sera déployé vers Vercel en arrière-plan.