ドキュメント
SIGIL を自分のものにするために必要なすべて。このページは地図です。 設定例 はそのまま使える出発点、 API 契約 は凍結された正式リファレンス。要件とインストールは README に。
ヘッダー — サイト名、言語切替、ナビゲーションが読書ページの上に置かれます。
本文 — 本文欄には見出し、段落、引用、コードが入ります。長文を読みやすくするため、行の長さを抑えています。
傍注 — 通常の Markdown 脚注は広い画面では余白へ、狭い画面では文末へ移ります。この図は役割の分解図であり、スマートフォンの実際の配置ではありません。
目次 — 目次は記事の見出しから作られ、有効なときに表示されます。本文を変えずに、読みたい位置を見つけられます。
フッター — 謝辞とサイト情報は本文の後に置かれます。記事に混ざらず、ページを閉じます。
はじめに
SIGIL は Hugo ≥ 0.166 extended で動作し、ビルド手順は不要です。baseURL を設定し、
設定例から [params] を選び、Markdown で記事を書きます。標準でラテン組版、傍注、
検索、ダークモードが使えます。日本語を実際の Plex で出したい場合は、任意のフォント
サブセット（bash scripts/build-fonts.sh corpus）が必要です。入れなければシステム
フォントにフォールバックします。
機能の使いかた
各機能はページ単位で opt-in です。ページが要求しないものは読み込まれません。記事の front matter で：
math = true # KaTeX。$...$ と \(...\) に対応
mermaid = true # ```mermaid ブロックからの図
lightbox = true # 画像のクリック拡大
- 傍注 —— 脚注
[^1]を書き、末尾で[^1]: 注の内容と定義します。広い画面では 余白に浮かび、狭い画面では巻末の注に畳まれます。テーマ固有の構文ではなく、普通の Markdown です。 - 多言語 —— 各言語の翻訳に同じ
translationKeyを付けると、言語切替が対応する記事へ 飛びます。翻訳のないページはその言語のホームに戻ります。 - フォント ——
latin（既定・クリーンな状態）、corpus（デモの日本語、約 30 KB）、full（SC + JP 全体、約 3 MB）。ページではなくサイト単位で選びます。
組版の見本 に、これらすべてが一ページにまとまっています—— 自分で書く前に、結果を確かめてください。
API リファレンス
テーマの公開契約は v0.9.0 で凍結されています。記載されたパラメータは、非推奨期間を 経ずに改名・削除されることはありません。API 契約 に、すべてのサイトパラメータ、 front matter パラメータ、CSS フック、拡張ポイントが記載されています。そこに記載のない ものは内部実装で、告知なく変更されえます。
詳細な技術ドキュメントは現在英語版のみです。上記の
/config-example/、/api/のリンクは英語原文を参照します。