Start

Getting started

Quill turns a folder of Markdown into a static site. Install it, point it at a folder, and build.

Install

Quill needs Node 20 or newer.

bun add --dev quill
bunx quill build docs/

The site is written to dist/. Serve it from any static host.

Put a quill.json next to your content. Every key is optional.

{
  "title": "My docs",
  "base": "/docs/",
  "nav": ["index.md", "guides/"]
}

Key	Default	What it does
`title`	`"Docs"`	Site title and page suffix.
`base`	`"/"`	Path prefix for every link.
`nav`	folder order	Sidebar entries, top to bottom.