オプション#

English 版もあります。

設定ファイルはありません（ADR 5）。 Tsumugu に指示できるのはこのページの内容だけです。コマンド 2 つ、そのオプション、 front matter の 4 つのキーです。

コマンド#

npx tsumugu dev [ディレクトリ] [オプション]     # 書きながら localhost で配信
npx tsumugu build [ディレクトリ] [オプション]   # 静的サイトを書き出す
npx tsumugu --version
npx tsumugu --help

ディレクトリは位置引数で、--root はそれをフラグで書いた形です。どちらも なければ ./docs を、それもなければ index 文書のあるカレントディレクトリを 配信します。知らないオプションは推測せずエラーになります。

dev#

監視・再ビルド・開いているページの再読み込みにフラグはありません。dev は 常にそうします。ライブリロードにもフラグはありません。Tsumugu がページに足す 唯一のスクリプトで、静的ビルドには入りません （ADR 3）。

build#

--clean がなければ、Tsumugu は自分の出力でないディレクトリを消しません。 --out を打ち間違えても失うものはありません。

--locales と --lang#

--locales ja,en-US はルート直下のディレクトリを指定し、それぞれを独立した スコープにします。/ja と /en-US はナビゲーション、検索、documents.json、 llms.txt を別々に持ち、互いのページは載りません。ルートに残ったものは共通で、 ルートの sitemap.xml は全体を含みます。

値は Unicode のロケール識別子で、正規化されます。en-us は en-US という ディレクトリを選びます。ディレクトリがない場合や、2 つの値が同じロケールを 指す場合は、配信もビルドも始まる前に停止します。

--lang が効くのは共通スコープだけで、ロケールのスコープは常に自身の ロケールを使います。理由は ADR 8、 ディレクトリの形は使い方にあります。

--trust#

既定で無効、推測されることはありません。付けなければドキュメントは内容として 扱われ、HTML の <script> は取り除かれ、MDX のコンポーネントはソースとして 表示されます。付けるとマークアップは書かれたまま出力され、スクリプトは動き （インラインはハッシュ、ファイルは 'self'、外部オリジンは常に不可）、.mdx はページを組み立てる間に実行されます。

自分で書いたディレクトリには付け、それ以外には付けないでください （ADR 6、 ADR 7）。

front matter#

キーは 4 つで、これが文書に対する設定のすべてです。

---
title: セットアップ
description: 一文の説明。
order: 2
hidden: true
---

hidden: true はナビゲーション、検索、llms.txt、sitemap.xml からページを 外しますが、URL では配信されます。documents.json には印を付けたまま残ります。 プロジェクトを読む道具には事実を渡すためです。

型違いや知らないキーは警告どまりで、拒否はしません。ページは読めるままです。 hiden には「もしかして hidden?」という警告が出ます。

終了コード#