Welcome
Polaris is a documentation template you can clone, edit, and ship as the docs site for any developer tool, library, or API. The structure is opinionated; the content is yours to replace.
What's in this template
- Getting started — install + first run, in under a page
- Configuration reference — every option, in a single scannable table
- API reference — endpoint + method tables with examples
- Release notes — chronological changelog, surfaced via the Posts page
- Browse by topic — automatic tag aggregation across every page
- Contact — support routing for users who can't find an answer
How to use it
- Clone this directory
- Replace every page in
content/with your own copy - Update brand colour, logo URL, and footer copyright in the frontmatter
- Build with
cargo run --example docs - Deploy the contents of
examples/docs/public/to any static host
That's it. The plugins, sitemap, search index, and accessibility report all work without further configuration.