lucid.page Documentation, without the docs site
Text size
Use caseDocumentation
Documentation

Documentation, without the docs site

A three-page project does not need a static site generator, a Node toolchain, and a theme config. It needs three good pages.

On this page

# The honest amount of tooling

Documentation sites have a gravity of their own: install the generator, learn its config, pick a theme, wire the deploy, then keep the whole apparatus alive for what was supposed to be a README with ambitions. Most projects quietly give up, and their docs stay a wall of Markdown in a repo.

lucid.page collapses that to writing. Each page is published as it’s finished, at a link you can put in the repo, the package readme, or the release notes.

# Books from Markdown files

When one page stops being enough, a bundle turns a set of pages into a book: a landing page that lists the chapters, previous and next navigation at the foot of each chapter, and every chapter living at its own URL under the bundle. A getting-started guide, an API walkthrough, and a FAQ become a small, coherent thing a reader can actually move through.

# Readable by people, and by their machines

Every page keeps its source. The rendered HTML is for humans; the Markdown is one request away for everything else:

bash
curl https://lucid.page/raw/your-docs

That makes a page a fair input for scripts, for reviewers’ editors, and for the tools your team already talks to. Publishing itself is a plain HTTP API, so docs can ship straight from CI — the agent documentation covers the interface.

# Common questions

# Can documentation span multiple pages?

Yes. Bundles group any number of pages into a book with a landing page and chapter navigation — each chapter still has its own URL.

# Do I have to deploy anything?

Nothing. Paste Markdown and publish; hosting, rendering, and the reading experience are the product.

# Is there an API for publishing docs?

Yes — publishing is a single HTTP POST, designed to be called from CI or by agents. See the agent documentation.

Write it. Paste it. Send the link.