Skip to content

変数

以下はブックのパースとテーマ生成時に利用可能なデータの参考例です。

グローバル変数

変数説明
book本全体の情報 + 設定を book.json から取得します。詳細は以下を参照。
honkitHonKitの具体的な情報
gitbookHonKit固有の情報です。これは honkit のエイリアスです。
page現在のページ固有の情報
file現在のページの特定情報に関連するファイル
readmeReadmeに関する情報
glossary用語集に関する情報
summary目次に関する情報
languages多言語ブックの言語一覧
output出力ジェネレーターに関する情報
configbook.jsonをダンプする。

Book変数

変数説明
book.[CONFIGURATION_DATA]book.jsonで設定したすべての変数は、book変数を通して利用することができます。
book.language多言語ブックの現在の言語

HonKit変数

変数説明
honkit.time現在の時刻(honkitコマンドを実行したとき)。
gitbook.time現在の時刻(honkitコマンドを実行したとき)。
honkit.versionブックの生成に使用したHonKitのバージョン
gitbook.versionブックの生成に使用したHonKitのバージョン

File変数

変数説明
file.pathrawページへのパス
file.mtime修正時刻。ファイルが最後に変更された時間
file.typeこのファイルをコンパイルするために使用したパーサーの名前 (例: markdown, asciidoc, など)

Page変数

変数説明
page.titleページのタイトル
page.previous目次の前のページ (null も可)
page.next目次の次のページ (null も可)
page.dir設定に基づくか、コンテンツから検出されたテキストの方向 (rtl または ltr)

目次変数

変数説明
summary.parts目次のセクションのリスト

目次(SUMMARY.md)全体にアクセスすることができる。

summary.parts[0].articles[0].titleは、最初の記事のタイトルを返します。

多言語ブック変数

変数説明
languages.listブックの言語一覧

言語は { id: 'en', title: 'English' } で定義されます。

出力変数

変数説明
output.name出力ジェネレータの名前。指定可能な値はwebsitejsonebookです。
output.formatoutput.name == "ebook" の場合、format は生成される電子書籍の形式を定義します。可能な値はpdfepubmobi です。

Readme変数

変数説明
readme.pathブック内のReadmeへのパス

用語集変数

変数説明
glossary.pathブックに掲載されている用語集へのパス