MarkDocs
Projets

Créer un projet

Nous assumerons que vous avez déjà un dossier contenant au moins un document .md. Vous aurez également besoin d’un dossier qui contient toutes les images attachées, cette option s’appelle « Chemin du dossier des pièces jointes » dans « Fichiers & Liens » sur Obsidian, il peut se situer en dehors de votre projet.

Dans un terminal, vous pouvez entrer markdocs init et répondre aux différentes questions qui vous seront posés pour créer un projet. Un dossier _markdocs sera créé dedans et inclura les principaux éléments de configuration à modifier avant de construire votre site pour la première fois.

Créer un projet depuis le CLI

Initialiser un projet

markdocs init

Différentes questions vous seront posés et un fichier de configuration sera créé.

Modifier la configuration

Les réponses que vous avez donnée lors de la précédente étape ont aidé le CLI à créé un fichier de configuration presque prêt à l'emploi. Vous aurez cependant besoin d'ouvrir le fichier situé à _markdocs/config.jsonc et de modifiez l'organisation par défaut en lisant la page de la documentation associée.

Construire le projet

Félicitations, votre projet est prêt à être construit pour la première fois !

Sur cette page