Skip to content
What is Tsumugu

What is Tsumugu?#

This guide is also available in 日本語.

Tsumugu turns a directory of Markdown, MDX, and HTML files into a documentation site. It derives routes and navigation from the files, so there is no configuration file to maintain.

This site runs on Tsumugu itself. From a checkout, pnpm docs serves the same pipeline that the packages ship.

Tsumugu is experimental and pre-alpha. Its APIs may change between releases.

  • How to Use — install it, write documentation, run the local server, and publish a static site.

  • Options — every command-line option and every front matter key, with what each one changes.

Beyond the guide#

The design records sit outside this guide, in English only: Designs explains the architecture and the constraints behind it, Decisions records accepted architectural decisions, and RFCs holds proposals that still need agreement or evidence.