ドキュメント拡張

マニュアルの周辺ページを作るレイアウトです。自分のページでだけ modootoday-docs-extra.css を読み込み、JavaScript は追加しません。どのレイアウトもタイトルとリード文の description: を読み、本文は生成部分の後に置かれます。

レイアウト	front matter	構造化データ	デモ
reference	members: [{name, signature, text, since, id}]	TechArticle	リファレンス
changelog	releases: [{version, date, url, added, changed, fixed, removed, security}]	WebPage	変更履歴
roadmap	items: [{title, status, text, url}]、status は now、next、later	WebPage	ロードマップ
glossary	terms: [{term, text, id}]	DefinedTermSet	用語集
hub	cards: [{title, text, url}]	CollectionPage	ハブ
course	level、modules: [{title, lessons: [{title, url, minutes}]}]	Course	コース
book	image、author、isbn、pages、chapters: [{title, url}]	Book	書籍
reference に sidebar: true、packages:	メンバーの group、packages: [{name, version, text, url, links: [{label, url}]}]、packages_title、packages_compact、packages_position	TechArticle	API リファレンス

変更履歴

各リリースの変更を 5 つの分類見出しの下に決まった順で示し、見出しはページの言語で表示されます。項目は Markdown です。modootoday-check はそれ以外のキーを報告するので、fix: のような打ち間違いが黙って消えることはありません。

用語集

用語は自動で並べ替えられ、最初の文字でまとめられます。文字バーは使われている文字にだけリンクします。各用語にアンカー（id: または用語のスラッグ）が付き、ページデータでは DefinedTerm として並びます。

コース

レッスンの minutes の合計が、タイトル下の合計時間と timeRequired になります。コースの提供者はサイトの発行者で、description: は必須です。

API サイドバーとパッケージ表

どちらも reference レイアウトで必要なときだけ有効にするもので、使わないページの表示は変わりません。sidebar: true にするとメンバー一覧が横の列に移り、広い画面（64rem 以上）ではスクロールしても表示されたままになります。group: が同じメンバーはその名前の下にまとまり、グループは最初に現れた順に並びます。狭い画面では同じ一覧が本文の上に置かれます。packages: は本文の前に、パッケージごとに 1 行で名前・バージョン・リンクを示す表を加え、text は名前の下に表示されます。小さな画面では行ごとに小さなカードのように積み重なります。packages: があるリファレンスページでは members: を省略できます。どちらも CSS だけで動きます。

本文ですでに各パッケージを説明している場合は、packages_compact: true で名前の下の text を省き、packages_position: after で表を本文の後ろに移せます（既定は before）。Markdown ページでは表を front matter でだけ指定します。GitHub では Liquid がそのまま文字として表示されるため、modootoday-check は本文中の Liquid をエラーにします。独自のレイアウトや HTML ページでは、表を置きたい位置で modootoday/docs-extra/packages.html を include します（items=page.packages、必要に応じて caption= と compact=true）。リファレンスページの本文にある GitHub アラート（> [!TIP] など）は、doc レイアウトと同じくコールアウトに変換されます。ページの Markdown 版と llms-full.txt にも、パッケージ表が同じ位置に Markdown の表として入ります。

検査

modootoday-check は、各レイアウトの基になるリスト、正しい status、用語ごとの text、重複のない用語、ハブカードごとの url、整数の minutes と pages、10 桁または 13 桁の isbn を求めます。