# minidoc

> minidoc is a small documentation website generator from the épure toolset. YAML configs declare variables and build outputs; contexts are dictionaries of templates; you inherit formulas, not values. This site is built with it.

The site is a single page; the links below point at its sections. The
complete guide as one markdown file is in
[llms-full.txt](https://minidoc.dev/llms-full.txt).

## Guide

- [One config, one site](https://minidoc.dev/#quick-start): The advised workflow when starting a new documentation website — design, install, agent-written sources, dev server. Then a base index.html layout, one config, one site — every declared output is rendered and written.
- [Contexts — dictionaries of templates](https://minidoc.dev/#model): Contexts merge and you inherit formulas, not values. How references render and how to escape one.
- [Var kinds — file, dir, dirs, list, value](https://minidoc.dev/#vars): The five var kinds — file, dir, dirs, list, value — plus transform inference from file extensions, frontmatter, optional files and ordering.
- [Build entries — inputs, pages, copies](https://minidoc.dev/#build): Build entries — template or file/dir inputs, one output per file with pages, copy entries, output collisions, and how declared paths resolve against their config.
- [Errors — fail loud, sited](https://minidoc.dev/#errors): Errors fail loud and carry their site — file, build entry, line number; inlineErrors renders content errors in place for a dev server.
- [run, transforms, filesystems](https://minidoc.dev/#api): The run API, custom text transforms, injectable filesystems, and the source layout.
- [Watch, rebuild, live reload](https://minidoc.dev/#dev): The dev and watch runners — watch, rebuild in a fresh process, serve with live reload — and the remembered port.

## Optional

- [Example setup](https://github.com/epuremethod/minidoc/tree/main/docs): this site's source — base layout, config, build, dev
- [llms-full.txt](https://minidoc.dev/llms-full.txt): the full guide, one markdown file
- [GitHub](https://github.com/epuremethod/minidoc): source, issues, releases