• # Mkdocs

    Posté par . En réponse au journal Static Site Generator. Évalué à 5.

    J'utilise Mkdocs pour faire une doc "glue" centralisée pour mon équipe au travail. J'y regroupe par activité une présentation générale de l'activité, les ressources-clés (documentaires, humaines, organisationnelles, informatiques...), les liens utiles vers ces diverses ressources au sein de l'entreprise et des commentaires sur leurs cas d'usages.

    L'idée est d'avoir un pense-bête en mode "source de vérité unique" (inspiré d'un journal récent sur gitlab), qui puisse aussi servir pour l'accueil de nouveaux arrivants.

    J'ai dû écrire un petit plugin privé pour pouvoir générer le site de manière à ce qu'il soit utilisable complètement hors ligne, l'option de base de mkdocks ne fonctionnant pas bien, et mon équipe ne disposant pas de solution d'hébergement web au travail. Au final ça marche très bien comme ça, j'ai aussi activé le plugin de recherche indexée hors ligne de mkdocs, avec l'index stocké dans un js, ce qui fait qu'on peut facilement trouver n'importe quelle info, même en hors ligne.

    Ce n'est pas vraiment ton cas d'usage cible, mais c'était l'occasion de faire un petit retour d'expérience sur cette utilisation possible de l'outil, qui est peut-être moins personalisable que d'autres, mais qui suffit pour ce qu'on en fait.

    Je compte aussi l'utiliser pour générer des petits tableaux de bord statiques mis à jour chaque matin et disponibles sur les espaces partagés réseau, avec des verbatims d'analyse simples générés automatiquement et une navigation intuitive entre les pages/onglets fournie par mkdocs. Ça évitera de contibuer à coller un peu plus de Power BI partout dans la boîte.