Aller au contenu

Documentation MkDocs (Tips)⚓︎

Documentation

Documentation complète sur mkdocs.org :

MKDocs

01 - Installation⚓︎

Vérifier qu'il y ai python et pip sur le serveur ([nom programme] --version) puis :

1
pip3 install mkdocs

Si le terminal vous signale un chemin (PATH) absent, l'ajouter avec :

1
export PATH="/le/chemin/a/ajouter:$PATH"

02 - Commandes MKDocs⚓︎

  • mkdocs new [nomDuSite] - Créer un nouveau projet.
  • mkdocs build - Build le site.
  • mkdocs build --clean - Nettoyage de la Build.
  • mkdocs --help - Documentation.

03 - Admonition⚓︎

Ajouter l'extension Admonition dans votre mkdocs.yml avec :

1
2
markdown_extensions:
    - admonition

Syntax de l'extension :

1
2
3
4
!!! type "Titre optionnel avec les guillemets doubles"
    Texte du bloc avec une indentation.

    Second paragraphe.

Les types possibles : attention, caution, danger, error, hint, important, note, tip, et warning.

Exemples d'utilisation :

Titre du bloc Danger

Lorem Ipsum

Hint

Lorem Ipsum

Note

Lorem Ipsum

Warning

Lorem Ipsum