Introducing lildocs

A map of the lildocs documentation, from first build through authoring, configuration, styling, and GitHub Pages deployment.

lildocs builds a static, searchable documentation site from Markdown files. The default path is intentionally short:

lildocs ./docs

Use this documentation to learn how lildocs resolves input, turns folders into site navigation, applies configuration, and prepares output for local preview or GitHub Pages.

Start Here

  • Getting started covers installation, the first build, and local development.
  • Authoring docs explains Markdown support, page titles, navigation, assets, callouts, Mermaid, and search.
  • CLI reference lists every command and flag.

Configuration And Styling

  • Configuration documents config.json, schema support, and CLI flag mappings.
  • Themes and styling covers built-in themes, Shiki themes, local theme.ts, fonts, backgrounds, and link styling.

Publishing