Introducing lildocs

A map of the lildocs documentation, from first build through content, navigation, search, diagrams, configuration, and 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.
• CLI reference lists every command and flag.

Features

• Writing content covers Markdown, page metadata, links, assets, and callouts.
• Navigation and page structure explains home-page discovery, generated sidebars, ordering, breadcrumbs, and transitions.
• Local search covers the static index, section-level results, and keyboard navigation.
• Mermaid diagrams explains build-time static rendering, themes, and error reporting.
• Generated API reference turns exported TypeScript declarations into static reference pages.

Configuration And Styling

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

Publishing

• GitHub Pages deployment shows how to generate Pages-ready output and initialize a deployment workflow.