--- title: "mdBook：レンダラーの設定" documentId: "mdbook:guide/src/format/configuration/renderers.md" order: 18 licenseSource: "mdbook-guide" documentContext: [{"kind": "source", "html": "

mdBook 0.5.4公式文書の非公式日本語訳。文書とその翻訳はMPL-2.0。固定した原典 · 編集可能な日本語文書 · 固定原資料一式。 · 編集可能な英日原稿とビルド資料.

"}, {"kind": "editorial", "html": "

Libxでは全文・コード・図・原目次を静的に提供します。原著の編集・実行機能は原典を参照してください。コードの非表示行は全表示し、数式は原TeX表記を保持します。章の操作説明はmdBookが生成した元の本を対象とします。

"}, {"kind": "editorial", "html": "

原素材のFont Awesome SVGは変更せず、CC BY 4.0の通知を保持します。非アイコンコードにはMIT等の素材別条件を適用します。Font Awesome 5の原通知 · Font Awesome 6の原通知。

"}] prev: {"text": "プリプロセッサー", "link": "/v0-5-4/ja/01-guide/18-format-configuration-preprocessors"} next: {"text": "環境変数", "link": "/v0-5-4/ja/01-guide/16-format-configuration-environment-variables"} ---

レンダラーの設定

レンダラー（「バックエンド」とも呼びます）は、本の出力を生成します。

次のバックエンドが組み込まれています。

コミュニティは、いくつかのバックエンドを開発しています。利用できるバックエンドの一覧は、WikiのThird Party Pluginsページを参照してください。

新しいバックエンドの作り方は、開発者向けのバックエンドの章を参照してください。

出力テーブル

book.tomlに、バックエンド名を付けたoutputテーブルを追加すると、バックエンドを使えます。たとえば、mdbook-wordcountというバックエンドなら、次のように指定します。

[output.wordcount]

このテーブルによって、mdBookはmdbook-wordcountバックエンドを実行します。

このテーブルには、バックエンド固有のキーと値の組も追加できます。たとえば、例のバックエンドに追加の設定が必要なら、次のように指定します。

[output.wordcount]
ignores = ["Example Chapter"]

[output]テーブルを1つでも定義すると、htmlバックエンドは既定では有効になりません。引き続きhtmlバックエンドを使うには、book.tomlファイルに追加してください。例を示します。

[book]
title = "My Awesome Book"

[output.wordcount]

[output.html]

outputテーブルを複数追加すると、出力ディレクトリの構成が変わります。バックエンドが1つなら、出力はbookディレクトリへ直接置かれます（場所を変更するにはbuild.build-dirを参照してください）。バックエンドが複数なら、それぞれの出力をbook内の別々のディレクトリへ置きます。たとえば、上の例ではbook/htmlとbook/wordcountになります。

独自バックエンドのコマンド

既定では、book.tomlへ[output.foo]テーブルを追加すると、mdbookはmdbook-foo実行ファイルの呼び出しを試みます。別のプログラム名を使ったり、コマンドライン引数を渡したりする場合は、commandフィールドを追加して、この動作を上書きできます。

[output.random]
command = "python random.py"

任意のバックエンド

有効にしたバックエンドがインストールされていない場合、既定ではエラーになります。バックエンドを任意と指定すると、この動作を変えられます。

[output.wordcount]
optional = true

これによって、エラーが警告になります。

HTMLレンダラーの設定

HTMLレンダラーには、以下に詳しく説明するさまざまな設定があります。book.tomlファイルの[output.html]テーブルに指定してください。

# Example book.toml file with all output options.
[book]
title = "Example book"
authors = ["John Doe", "Jane Doe"]
description = "The example book covers examples."

[output.html]
theme = "my-theme"
default-theme = "light"
preferred-dark-theme = "navy"
smart-punctuation = true
definition-lists = true
admonitions = true
mathjax-support = false
additional-css = ["custom.css", "custom2.css"]
additional-js = ["custom.js"]
no-section-label = false
git-repository-url = "https://github.com/rust-lang/mdBook"
git-repository-icon = "fab-github"
edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
site-url = "/example-book/"
cname = "myproject.rs"
input-404 = "not-found.md"
sidebar-header-nav = true

次の設定が使えます。

[output.html.print]

[output.html.print]テーブルでは、印刷出力を制御します。既定では、mdBookは本の右上にアイコン（）を置き、本全体を1ページとして印刷できるようにします。

[output.html.print]
enable = true    # include support for printable output
page-break = true # insert page-break after each chapter

[output.html.fold]

[output.html.fold]テーブルでは、ナビゲーションサイドバーの章の一覧を折りたたむ動作を制御します。

[output.html.fold]
enable = false    # whether or not to enable section folding
level = 0         # the depth to start folding

[output.html.playground]

[output.html.playground]テーブルでは、Rustのコード例と、Rust Playgroundとの連携を制御します。

[output.html.playground]
editable = false         # allows editing the source code
copyable = true          # include the copy button for copying code snippets
copy-js = true           # includes the JavaScript for the code editor
line-numbers = false     # displays line numbers for editable code
runnable = true          # displays a run button for rust code

[output.html.code]

[output.html.code]テーブルでは、コードブロックを制御します。

[output.html.code]
# A prefix string per language (one or more chars).
# Any line starting with whitespace+prefix is hidden.
hidelines = { python = "~" }

[output.html.search]

[output.html.search]テーブルでは、組み込みの全文検索を制御します。mdBookはsearch機能を有効にしてコンパイルする必要があります（既定で有効です）。

[output.html.search]
enable = true            # enables the search feature
limit-results = 30       # maximum number of search results
teaser-word-count = 30   # number of words used for a search result teaser
use-boolean-and = true   # multiple search terms must all match
boost-title = 2          # ranking boost factor for matches in headers
boost-hierarchy = 1      # ranking boost factor for matches in page names
boost-paragraph = 1      # ranking boost factor for matches in text
expand = true            # partial words will match longer terms
heading-split-level = 3  # link results to heading levels
copy-js = true           # include Javascript code for search

[output.html.search.chapter]

[output.html.search.chapter]テーブルでは、章やディレクトリごとに検索設定を変えられます。各キーは章のソースファイルまたはディレクトリのパスで、値はそのパスへ適用する設定テーブルです。これらは再帰的にマージされ、より具体的なパスが優先されます。

[output.html.search.chapter]
# Disables search indexing for all chapters in the `appendix` directory.
"appendix" = { enable = false }
# Enables search indexing for just this one appendix chapter.
"appendix/glossary.md" = { enable = true }

[output.html.redirect]

[output.html.redirect]テーブルでは、リダイレクトを追加できます。ページを移動、改名、削除した際に、旧URLへのリンクを新しい場所へ誘導するために便利です。

[output.html.redirect]
"/appendices/bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html"
"/other-installation-methods.html" = "../infra/other-installation-methods.html"

# Fragment redirects also work.
"/some-existing-page.html#old-fragment" = "some-existing-page.html#new-fragment"

# Fragment redirects also work for deleted pages.
"/old-page.html" = "new-page.html"
"/old-page.html#old-fragment" = "new-page.html#new-fragment"

このテーブルにはキーと値の組を指定します。キーは、リダイレクト用のファイルを作成する場所を、ビルドディレクトリからの絶対パスで表します（例：/appendices/bibliography.html）。値には、ブラウザーの移動先となる任意の有効なURIを指定できます（例：https://rust-lang.org/、/overview.html、../bibliography.html）。

指定した場所へ自動でリダイレクトするHTMLページが生成されます。

フラグメントのリダイレクトを指定した場合、そのページはJavaScriptを使って正しい場所へ移動させる必要があります。節の見出しを改名、移動したときに便利です。フラグメントのリダイレクトは、既存のページと削除したページで使えます。

Markdownレンダラー

Markdownレンダラーは、プリプロセッサーを実行した後、その結果のMarkdownを出力します。主にプリプロセッサーのデバッグに便利で、特にmdbook testと組み合わせると、mdbookがrustdocへ渡すMarkdownを確認できます。

Markdownレンダラーはmdbookに含まれますが、既定では無効です。次の空のテーブルをbook.tomlへ追加すると、有効になります。

[output.markdown]

現時点でMarkdownレンダラーに設定項目はありません。有効か無効かだけを指定できます。

Markdownレンダラーの前に実行するプリプロセッサーの指定方法は、プリプロセッサーの文書を参照してください。