mdBook 0.5.4公式文書の非公式日本語訳。文書とその翻訳はMPL-2.0。固定した原典 · 編集可能な日本語文書 · 固定原資料一式。 · 編集可能な英日原稿とビルド資料.
"}, {"kind": "editorial", "html": "Libxでは全文・コード・図・原目次を静的に提供します。原著の編集・実行機能は原典を参照してください。コードの非表示行は全表示し、数式は原TeX表記を保持します。章の操作説明はmdBookが生成した元の本を対象とします。
"}] prev: {"text": "コマンドラインツール", "link": "/v0-5-4/ja/01-guide/02-cli-index"} next: {"text": "build", "link": "/v0-5-4/ja/01-guide/03-cli-build"} ---新しい本には、毎回共通する最小限のひな形があります。そのため、mdBookにはinitコマンドが用意されています。
initコマンドは次のように使います。
mdbook init
初めてinitコマンドを使うと、次のファイルなどが用意されます。
book-test/
├── book
└── src
├── chapter_1.md
└── SUMMARY.md
srcディレクトリは、Markdownで本を書く場所です。ソースファイルや設定ファイルなどがすべて含まれます。
bookディレクトリは、本の出力先です。すべての出力は、読者が閲覧できるようにサーバーへアップロードできる状態になっています。
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の作成と本のタイトルについてのプロンプトを省略します。