Logo de Kiln, un four surmonté d'une flamme

Kiln

Personnel

Actif

Un générateur de sites de documentation : un dossier docs/ en Markdown et un fichier docs.yml suffisent pour obtenir un site rapide et accessible, quel que soit le langage du projet, sans ajouter Node au dépôt.

Voir le projet →

Genèse du projet

Kiln est né d'une insatisfaction. Pour documenter mes projets, j'utilisais MkDocs, mais ses sites se ressemblent tous, quel que soit le projet : même mise en page, même thème, rien qui distingue une documentation d'une autre. Je voulais un système de documentation personnalisé, qui me corresponde et que je puisse réutiliser partout.

J'ai donc conçu Kiln comme un outil qui se branche sur n'importe quel dépôt : un dossier docs/ en Markdown, un fichier docs.yml, et toute la chaîne (Astro, Starlight et un thème sur mesure) tourne dans une image Docker. Mes projets ne contiennent que leur contenu, Kiln s'occupe du reste. Soong et Lyricsmith ont été les premiers à quitter MkDocs pour lui.

C'est avant tout un outil pour moi, mais il est en libre téléchargement sous licence MIT, et je serais ravi que d'autres développeurs l'adoptent pour leurs propres projets.

Choix techniques

Moteur
Astro et Starlight, avec un thème sur mesure
Distribution
Une image Docker qui embarque toute la chaîne
Publication
Workflow GitHub Actions réutilisable vers GitHub Pages
Configuration
Un seul docs.yml, validé au démarrage avec des erreurs à la ligne près
Contenu
Recherche Pagefind, coloration de plus de 200 langages, référence d'API Python générée depuis les docstrings

Roadmap du projet

  1. Première version (v1.0.0)

    Image Docker avec les commandes build, serve et validate, thème sur mesure et workflow GitHub Pages réutilisable.

    Terminé
  2. Adoption par Soong et Lyricsmith

    Leurs sites de documentation, auparavant sous MkDocs, sont construits avec Kiln.

    Terminé
  3. Référence d'API Python (v1.2.0)

    Une page par module, générée depuis les docstrings, avec le thème et la recherche du site.

    Terminé