pagers

pagers documentation

pagers turns a folder of Markdown files into a complete static website — clean URLs, generated navigation, light/dark themes, and an interactive graph of how pages link together. No build pipeline, no runtime, no configuration file required: one Rust binary.

pagers build ./docs

Quick start

pagers init my-site          # scaffold docs/index.md + an example page
pagers serve my-site/docs    # build + serve on http://localhost:8080
pagers build my-site/docs --output my-site/dist

See Getting started for installation and your first site.

Features

  • Zero configuration — the directory layout is the config; frontmatter covers ordering, labels and drafts.
  • Clean URLs — every page publishes at /section/page/, so dist/ works on any static host.
  • File-tree navigation — sidebar generated from folders and frontmatter.
  • GitHub-flavoured Markdown — tables, alerts, footnotes, heading ids and rewritten internal links.
  • Eight themes — palettes embedded in the binary, plus a persisted light/dark toggle.
  • Graph page — interactive map of page-to-page links on every build.
  • Wikipedia import — article URL → clean Markdown, with a BFS crawler for whole sections.
  • MCP server — pagers-mcp exposes build and inspection tools to AI agents over stdio.

Guides

  • Getting started — install, scaffold, build.
  • Commands — every CLI command and flag.
  • Configuration — frontmatter, pagers.yaml, basePath, URL rules.
  • Markdown — GFM syntax, heading ids, alerts, link rewriting.
  • Theming — palettes, tokens, the dark-mode toggle.
  • Graph — the page-link graph and pagers graph outputs.
  • Wikipedia — pagers wiki convert / pagers wiki info.
  • MCP server — client setup and the five pagers_* tools.
  • Scripts — installers and the examples.sh crawler.
  • Deploy — GitHub Pages workflow and other static hosts.

Internals

  • Architecture — the Cargo workspace, the build pipeline, and how to develop pagers itself.