initコマンド

新しい本には、毎回共通する最小限のひな形があります。そのため、mdBookにはinitコマンドが用意されています。

initコマンドは次のように使います。

mdbook init

初めてinitコマンドを使うと、次のファイルなどが用意されます。

book-test/
├── book
└── src
    ├── chapter_1.md
    └── SUMMARY.md

• srcディレクトリは、Markdownで本を書く場所です。ソースファイルや設定ファイルなどがすべて含まれます。

• bookディレクトリは、本の出力先です。すべての出力は、読者が閲覧できるようにサーバーへアップロードできる状態になっています。

• SUMMARY.mdは本の骨組みです。詳しくは別の章で説明します。

ヒント：SUMMARY.mdから章を生成する

SUMMARY.mdがすでにある場合、initコマンドはまずそれを解析し、SUMMARY.mdに記載されたパスに従って、不足しているファイルを生成します。本全体の構成を先に考えて作り、ファイルの生成をmdBookに任せられます。

ディレクトリを指定する

initコマンドは、現在の作業ディレクトリの代わりに本のルートとして使うディレクトリを、引数で指定できます。

mdbook init path/to/book

--theme

--themeフラグを使うと、ソースディレクトリ内のthemeというディレクトリへ既定のテーマがコピーされ、変更できるようになります。

テーマは選択的に上書きされます。特定のファイルを上書きしたくない場合は、そのファイルを削除すると、既定のファイルが使われます。

--title

本のタイトルを指定します。指定しない場合は、対話的なプロンプトでタイトルを尋ねられます。

mdbook init --title="my amazing book"

--ignore

本をビルドしたときに生成されるbookディレクトリを無視するよう設定した、.gitignoreファイルを作成します。指定しない場合は、作成するかどうかを対話的なプロンプトで尋ねられます。

mdbook init --ignore=none

mdbook init --ignore=git

--force

.gitignoreの作成と本のタイトルについてのプロンプトを省略します。