MkDocs — Créer un site de documentation

MkDocs est l'outil utilisé pour créer ce site ! Il génère des sites web à partir de fichiers Markdown.

Installation

pip install mkdocs mkdocs-material

Démarrage rapide

mkdocs new monsite   # Crée un nouveau projet
cd monsite
mkdocs serve         # Lance un serveur local de prévisualisation
mkdocs build         # Génère le site statique dans le dossier /site

Personnaliser les couleurs (extra.css)

Créez docs/stylesheets/extra.css et ajoutez-le dans mkdocs.yml :

extra_css:
  - stylesheets/extra.css

MkDocs en français

pip install mkdocs[i18n]

Dans mkdocs.yml :

theme:
  name: material
  language: fr

Pages de navigation avec flèches

theme:
  features:
    - navigation.footer