紡ぐとは#

このガイドは English でも読めます。

Tsumugu は、Markdown、MDX、HTML の入ったディレクトリを、そのまま ドキュメントサイトとして配信するツールです。ルーティングとナビゲーションは ファイル構成から作るため、設定ファイルはありません。

このサイト自体も Tsumugu で配信しています。チェックアウトした状態で pnpm docs を実行すると、パッケージが出荷しているものと同じパイプラインが 立ち上がります。

Tsumugu は実験段階（pre-alpha）です。API はリリース間で変わることがあります。

次に読む#

• 使い方 — インストール、執筆、ローカル配信、静的サイトの 公開までの手順。

• オプション — コマンドラインオプションと front matter の キーを、それぞれ何が変わるのかとあわせて全部。

ガイドの外にあるもの#

設計資料は、このガイドの外に英語で置いてあります。Designs は アーキテクチャとその制約、Decisions は採択済みの ADR、 RFCs はまだ合意や根拠を待っている提案です。