Créer des sites de documentation technique versionnés avec rech…

Créer des sites de documentation technique versionnés avec recherche et navigation à l'aide de Material for MkDocs

Utilisez Material for MkDocs pour transformer votre documentation Markdown en un site statique, navigable et recherche, avec une configuration prête pour vos projets et des aperçus.

Prérequis

Python, pip ou Docker, MkDocs, Material for MkDocs, fichiers de documentation Markdown

Installation

Utilisez la méthode d'installation en amont ou la configuration qui correspond à votre environnement :

• Personnalisez-le – changez les couleurs, les polices, la langue, les icônes, le logo, et plus encore avec
• pip install mkdocs-material

Exigences et mises en garde en amont :

• alt="Python Package Index"
• <img
• src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"

Notes d'utilisation de base ou de démarrage :

• Material for MkDocs peut être installé avec pip :

• sh

• Ajoutez les lignes suivantes à mkdocs.yml :

• Source : https://github.com/squidfunk/mkdocs-material

• Extrait de la documentation en amont : https://raw.githubusercontent.com/squidfunk/mkdocs-material/HEAD/README.md

Documentation

• https://squidfunk.github.io/mkdocs-material/

Source

• Agent Skill Exchange