Kiln logo, a kiln with a flame inside

Kiln

Personal

Active

A documentation site generator: a docs/ folder in Markdown and a docs.yml file are enough to get a fast, accessible site, whatever the project's language, without adding Node to the repository.

View Project →

Project Genesis

Kiln grew out of a frustration. I was using MkDocs to document my projects, but its sites all look the same whatever the project: same layout, same theme, nothing to tell one documentation from another. I wanted a documentation system of my own, one that fits me and that I could reuse everywhere.

So I designed Kiln as a tool that plugs into any repository: a docs/ folder in Markdown, a docs.yml file, and the whole toolchain (Astro, Starlight and a custom theme) runs inside a Docker image. My projects only hold their content, and Kiln takes care of the rest. Soong and Lyricsmith were the first to leave MkDocs for it.

It is first and foremost a tool for me, but it is free to download under the MIT license, and I would be glad to see other developers adopt it for their own projects.

Technical Choices

Engine
Astro and Starlight, with a custom theme
Distribution
A Docker image that ships the whole toolchain
Publishing
Reusable GitHub Actions workflow to GitHub Pages
Configuration
A single docs.yml, validated at startup with line-accurate errors
Content
Pagefind search, syntax highlighting for 200+ languages, Python API reference generated from docstrings

Project Roadmap

  1. First release (v1.0.0)

    Docker image with the build, serve and validate commands, custom theme and reusable GitHub Pages workflow.

    Completed
  2. Adopted by Soong and Lyricsmith

    Their documentation sites, previously on MkDocs, are built with Kiln.

    Completed
  3. Python API reference (v1.2.0)

    One page per module, generated from docstrings, with the site's theme and search.

    Completed