MkDocs : générateur de documentation

Logo MkDocsMkDocs est un outil de génération de documentation statique.

Les pages sont rédigées au format Markdown, et la configuration au format YAML.

La phase de création des pages peut se faire en mode live, et la génération se build très rapidement en une ligne de commande.

La documentation générée possède un menu, une barre de recherche, et plusieurs thèmes disponibles.

Installation

sudo apt install mkdocs

Initialisation d’une documentation

mkdocs new my-app

Visualisation de la documentation en mode live

mkdocs serve

Exemple simple de configuration du fichier mkdocs.yml

site_name: MyApp
pages:
    - Home: index.md
    - About: about.md
theme: readthedocs

Génération de la doc au format HTML

mkdocs build

Résultat
MkDocs exemple

D’autres thèmes sont disponibles sur le repository GitHub MkDocs-Themes

Exemple avec une configuration plus poussée

site_name: MyApp
copyright: 'Copyright © 2017 - 2018 Louis'
pages:
    - Accueil: index.md
    - About: about.md
theme:
    language: fr
    name: material
    palette:
        primary: indigo
        accent: indigo
markdown_extensions:
    - admonition
    - footnotes
    - codehilite:
        guess_lang: false
    - toc:
        permalink: true

MkDocs exemple custom

Share Button

Laisser un commentaire.

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.