Mkdocs

Bienvenue sur MkDocs

Pour une documentation complète, consultez mkdocs.org.

Commandes

• mkdocs new [dir-name] - Crée un nouveau projet.
• mkdocs serve - Lance le chargement automatique pour le serveur de documents.
• mkdocs build - Construit le site de documentation.
• mkdocs -h - Affiche le message d'aide et quitte.

Présentation du projet

mkdocs.yml # Le fichier de configuration.

docs/ index.md # La page de documentation. ... # Autres pages markdown, images et autres fichiers.

Documentation web appliquée aux pages github

mkdocs gh-deploy --config-file mkdocs.yml --remote-branch webdoc