ディレクトリ構造

HonKitはシンプルなディレクトリ構造を使用しています。SUMMARYにリストされたすべてのMarkdown/AsciidocファイルはHTMLに変換されます。多言語の書籍は若干異なる構造になっています。

基本的なHonKitは通常、次のようなものです。

.
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
|   ├── README.md
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md

それぞれの役割の概要を説明します。

ファイル	説明
book.json	設定データを格納する(任意)
README.md	本の序文 / 紹介文 (必須)
SUMMARY.md	目次（ページを参照） (任意)
GLOSSARY.md	用語集 / 注釈を付ける用語のリスト（用語集を参照） (任意)

静止画ファイル・画像

静的ファイルとはSUMMARY.mdにリストされていないファイルのことです。無視されない限り、すべての静的ファイルは出力にコピーされます。

ファイル＆フォルダの無視

HonKitは.gitignore・.bookignore・.ignore ファイルを読み込んでスキップするファイルやフォルダのリストを取得します。 これらのファイル内のフォーマットは.gitignoreと同じ規則に従います。

# これはコメントです

# test.md ファイルを無視します
test.md

# binディレクトリにあるものはすべて無視する。
bin/*

サブディレクトリを使ったプロジェクト統合

ソフトウェアプロジェクトでは、プロジェクトのドキュメント用のブックを保存するためにサブディレクトリ（docs/など）を使用することができます。また、root オプションでHonKitがブックのファイルを見つけることができるフォルダを設定することができます。

.
├── book.json
└── docs/
    ├── README.md
    └── SUMMARY.md

book.jsonに含めます。

{
    "root": "./docs"
}