docshelf turns a folder of Markdown files into a static documentation site. The source stays readable, the output is portable, and the generated pages work without an application server.

The basic workflow

  1. Install docshelf in your project.
  2. Run docshelf init to create the starter files.
  3. Write pages in docs/.
  4. Run docshelf check before publishing.
  5. Build and upload dist/ to your static host.
Getting started

Install the package and create your first page.

Writing docs

Learn Markdown, frontmatter, links, and components.

Configuration

Organize site settings in one TOML file.

Customize

Change the header, theme, icon, and interface.

Deploy

Publish to Cloudflare Pages, GitHub Pages, or another static host.

What gets generated

The build produces HTML pages, the default stylesheet, the client-side search index, a 404 page, copied public files, optional sitemap and RSS files, robots metadata, and social images.

Read the official documentation for the public guide and the package source for implementation details.