Mes Cours, documentations et TPs avec MkDocs

Reading is fun par Vincent Fuh

MkDocs en résumé

MkDocs est un générateur de documentations. C’est un peu l’équivalent de Hugo, Jekyll et autres générateurs de sites Ouebs mais plus spécifiquement utilisé pour les documentations (menus, sommaires automatiques).

Il prend une arborescence de fichiers Markdown en entrée et se débrouille pour faire ses menus en fonction des sous-répertoires.

Vous trouverez tout ce dont vous avez besoin dans la doc (générée par MkDocs ;-) ).

J’ai transformé toutes mes documentations de LibreOffice à Markdown gràce à l’excellent Pandoc, qui peut transformer à peu près tous les types de fichiers en tous les types de fichiers !

Donc avec une arborescence de fichiers en Markdown mkdocs peut vous montrer en local votre site :

mkdocs serve

Aller sur http://127.0.0.1:8000

Et peut vous générer un site statique que vous n’avez qu’à déposer sur un serveur Oueb :

mkdocs build

Du coup, à partir d’aujourd’hui, mon seul logiciel bureautique est Vim

\o/

et mon seul format de fichier est Markdown

\o/

Mes documents

Tous mes documents sont sur https://cours.adminrezo.fr mais attention, il y a à boire et à manger, les documents récents cotoient les très vieux, plus du tout adaptés.

A vous d’en faire ce que vous voulez, ces documents sont sous licence Creative Commons BY-SA.

Si vous souhaitez commenter, c’est, comme d’hab, sur Mastodon que ça se passe.