mdBook 0.5.4公式文書の非公式日本語訳。文書とその翻訳はMPL-2.0。固定した原典 · 編集可能な日本語文書 · 固定原資料一式。 · 編集可能な英日原稿とビルド資料.
"}, {"kind": "editorial", "html": "Libxでは全文・コード・図・原目次を静的に提供します。原著の編集・実行機能は原典を参照してください。コードの非表示行は全表示し、数式は原TeX表記を保持します。章の操作説明はmdBookが生成した元の本を対象とします。
"}] prev: {"text": "全般", "link": "/v0-5-4/ja/01-guide/17-format-configuration-general"} next: {"text": "レンダラー", "link": "/v0-5-4/ja/01-guide/19-format-configuration-renderers"} ---プリプロセッサーは、レンダラーへ渡す前のMarkdownソースを変更できる拡張です。
次のプリプロセッサーは組み込まれており、既定で使われます。
links：章にあるhandlebarsヘルパー{{ #playground }}、{{ #include }}、{{ #rustdoc_include }}を展開し、ファイルの内容を取り込みます。詳しくはファイルを取り込むを参照してください。index：README.mdという名前の章ファイルをすべてindex.mdへ変換します。つまり、すべてのREADME.mdは、生成した本ではインデックスファイルindex.htmlとして出力されます。組み込みのプリプロセッサーは、build.use-default-preprocessors設定で無効にできます。
コミュニティは、いくつかのプリプロセッサーを開発しています。利用できるプリプロセッサーの一覧は、WikiのThird Party Pluginsページを参照してください。
新しいプリプロセッサーの作り方は、開発者向けのプリプロセッサーの章を参照してください。
book.tomlに、プリプロセッサー名を付けたpreprocessorテーブルを追加すると、プリプロセッサーを使えます。たとえば、mdbook-exampleというプリプロセッサーなら、次のように指定します。
[preprocessor.example]
このテーブルによって、mdBookはmdbook-exampleプリプロセッサーを実行します。
このテーブルには、プリプロセッサー固有のキーと値の組も追加できます。たとえば、例のプリプロセッサーに追加の設定が必要なら、次のように指定します。
[preprocessor.example]
some-extra-feature = true
プリプロセッサーとレンダラーを結び付けると、そのレンダラーに対してプリプロセッサーを実行することを明示的に指定できます。
[preprocessor.example]
renderers = ["html"] # example preprocessor only runs with the HTML renderer
既定では、book.tomlへ[preprocessor.foo]テーブルを追加すると、mdbookはmdbook-foo実行ファイルの呼び出しを試みます。別のプログラム名を使ったり、コマンドライン引数を渡したりする場合は、commandフィールドを追加して、この動作を上書きできます。
[preprocessor.random]
command = "python random.py"
有効にしたプリプロセッサーがインストールされていない場合、既定ではエラーになります。プリプロセッサーを任意と指定すると、この動作を変えられます。
[preprocessor.example]
optional = true
これによって、エラーが警告になります。
プリプロセッサーの実行順序は、beforeとafterフィールドで指定できます。たとえば、linenosプリプロセッサーで、{{#include}}によって取り込まれた行を処理したい場合は、組み込みのlinksプリプロセッサーの後に実行する必要があります。beforeかafterフィールドで、この順序を指定できます。
[preprocessor.linenos]
after = [ "links" ]
または、次のように指定します。
[preprocessor.links]
before = [ "linenos" ]
冗長にはなりますが、上の両方を同じ設定ファイルに指定することもできます。
beforeとafterによる優先度が同じプリプロセッサーは、名前で並べ替えます。無限ループは検出され、エラーになります。