Skip to content

Documentation MkDocs

Table des Matières

  1. Introduction
  2. Installation
  3. Création d'un Nouveau Projet
  4. Ajouter des Pages
  5. Configuration
  6. Thèmes
  7. Construire le Site
  8. Déploiement

Introduction

MkDocs est un outil rapide et simple pour créer un site web à partir de fichiers Markdown. Il est particulièrement adapté pour créer des documentations.

Installation

Pour installer MkDocs, exécutez la commande suivante : pip install mkdocs

Création d'un Nouveau Projet

Pour créer un nouveau projet MkDocs, utilisez :

mkdocs new mon-projet
cd mon-projet

Ajouter des Pages

Pour ajouter des pages à votre documentation, placez vos fichiers Markdown dans le dossier docs. Par exemple :

echo "# Ma Page" > docs/ma-page.md

Configuration

Votre site peut être personnalisé en modifiant le fichier mkdocs.yml à la racine de votre projet.

Thèmes

MkDocs offre plusieurs thèmes intégrés. Pour utiliser un thème, ajoutez la ligne suivante à votre mkdocs.yml :

theme: nom_du_thème

Par exemple, pour le thème Material :

theme: material

Construire le Site

Pour construire votre site, utilisez :

mkdocs build

Cela génère un dossier site contenant les fichiers HTML statiques.

Déploiement

Votre site MkDocs peut être déployé sur diverses plateformes d'hébergement. La commande suivante déploie sur GitHub Pages :

mkdocs gh-deploy