Introduction
MarkDocs est un CLI permettant de transformer une collection de fichiers Markdown en une véritable documentation, fonctionnelle et prête à être déployée rapidement.
Il créé automatiquement et localement un projet en utilisant un template Fumadocs dans un dossier temporaire de votre ordinateur. Ce projet est ajusté en fonction de vos documents et de votre configuration MarkDocs. Il est ensuite possible de le déployer automatiquement sur Vercel, ou manuellement ailleurs.
Débuter
Avertissement
MarkDocs est conçu pour les utilisateurs avancés, vous aurez besoin de savoir gérer un minimum les commandes dans un terminal, ainsi que savoir lire et modifier un fichier de configuration au format JSON.
Installer NodeJS
Vous aurez besoin d'avoir une version récente de NodeJS installée sur votre appareil. Vous pouvez vérifier si elle est déjà présente en exécutant node --version. Si une erreur est affichée, ou que la version retournée est inférieure à 20, vous devrez effectuer une (ré)installation avec la commande suivante :
Vérifier l'installation
Si MarkDocs est installé, vous pouvez débuter en créant votre premier projet !