tree-to-book
v1.2.0
Published
sections 正本(src/sections → dist/BOOK.md)向けの CLI とテンプレート
Maintainers
Readme
プロジェクト概要
このリポジトリは tree-to-book のセクション版テンプレートから生成されています。src/sections/ のディレクトリ構造を正本として製本順を決め、dist/BOOK.md を生成します。詳細仕様は docs/SPEC.md を参照してください。
コマンド
npm install— 依存をインストールnpm run validate— 構造・参照・deps を検証npm run compile—dist/BOOK.mdを生成npm run create-section -- --parent src/sections --name 0600_new --template sample-basic --title "新章タイトル"— サンプルテンプレートからセクション追加(npx でも可)--parentだけ指定すれば、名前は自動採番、テンプレートはsample-basic、タイトルは"New Section"が既定になります。省略した項目は対話プロンプト(TTY の場合)で入力できます。
- コンテンツカタログ:
src/catalog.content.yamlに TERM/REQ を記述し、本文中では[[TERM:...]]/[[REQ:...]]で参照します。参照があるのにカタログが無い、未定義の id を参照、id/desc形式違反はnpm run validateで検出されます。
ディレクトリ
src/sections/— 本文セクション(NNNN_slug/index.md)src/assets/— 資産置き場(画像など)src/catalog.content.yaml— TERM/REQ カタログdocs/— 仕様・ガイドdist/— 生成物(compileがBOOK.mdを出力)
カタログ例
id: TERM:example-term
desc: |
用語の定義をここに書く。
---
id: REQ:example-requirement
desc: |
必須条件や禁止事項をここに書く。本文での参照例: [[REQ:example-requirement]]
ライセンス
このテンプレートは MIT ライセンスです。必要に応じてプロジェクト方針に合わせてください。
