Updated the user guide's config section to mention specifying plugin commands

This commit is contained in:
Michael Bryan 2018-10-20 14:16:07 +08:00
parent e73928f933
commit cffc385b0c
No known key found for this signature in database
GPG Key ID: E9C602B0D9A998DC
2 changed files with 34 additions and 6 deletions

View File

@ -172,6 +172,9 @@ of a book in order to validate links or run tests. Some existing renderers are:
- [`linkcheck`] - a backend which will check that all links are valid - [`linkcheck`] - a backend which will check that all links are valid
- [`epub`] - an experimental EPUB generator - [`epub`] - an experimental EPUB generator
> **Note for Developers:** Feel free to send us a PR if you've developed your
> own plugin and want it mentioned here.
A preprocessor or renderer is enabled by installing the appropriate program and A preprocessor or renderer is enabled by installing the appropriate program and
then mentioning it in the book's `book.toml` file. then mentioning it in the book's `book.toml` file.

View File

@ -79,8 +79,8 @@ This controls the build process of your book.
The following preprocessors are available and included by default: The following preprocessors are available and included by default:
- `links`: Expand the `{{ #playpen }}` and `{{ #include }}` handlebars helpers in - `links`: Expand the `{{ #playpen }}` and `{{ #include }}` handlebars
a chapter to include the contents of a file. helpers in a chapter to include the contents of a file.
- `index`: Convert all chapter files named `README.md` into `index.md`. That is - `index`: Convert all chapter files named `README.md` into `index.md`. That is
to say, all `README.md` would be rendered to an index file `index.html` in the to say, all `README.md` would be rendered to an index file `index.html` in the
rendered book. rendered book.
@ -99,8 +99,9 @@ create-missing = false
### Custom Preprocessor Configuration ### Custom Preprocessor Configuration
Like renderers, preprocessor will need to be given its own table (e.g. `[preprocessor.mathjax]`). Like renderers, preprocessor will need to be given its own table (e.g.
In the section, you may then pass extra configuration to the preprocessor by adding key-value pairs to the table. `[preprocessor.mathjax]`). In the section, you may then pass extra
configuration to the preprocessor by adding key-value pairs to the table.
For example For example
@ -113,13 +114,26 @@ some_extra_feature = true
#### Locking a Preprocessor dependency to a renderer #### Locking a Preprocessor dependency to a renderer
You can explicitly specify that a preprocessor should run for a renderer by binding the two together. You can explicitly specify that a preprocessor should run for a renderer by
binding the two together.
``` ```
[preprocessor.mathjax] [preprocessor.mathjax]
renderers = ["html"] # mathjax only makes sense with the HTML renderer renderers = ["html"] # mathjax only makes sense with the HTML renderer
``` ```
### Provide Your Own Command
By default when you add a `[preprocessor.foo]` table to your `book.toml` file,
`mdbook` will try to invoke the `mdbook-foo` executa`ble. If you want to use a
different program name or pass in command-line arguments, this behaviour can
be overridden by adding a `command` field.
```toml
[preprocessor.random]
command = "python random.py"
```
## Configuring Renderers ## Configuring Renderers
### HTML renderer options ### HTML renderer options
@ -181,7 +195,8 @@ Available configuration options for the `[output.html.search]` table:
- **copy-js:** Copy JavaScript files for the search implementation to the output - **copy-js:** Copy JavaScript files for the search implementation to the output
directory. Defaults to `true`. directory. Defaults to `true`.
This shows all available options in the **book.toml**: This shows all available HTML output options in the **book.toml**:
```toml ```toml
[book] [book]
title = "Example book" title = "Example book"
@ -218,6 +233,16 @@ heading-split-level = 3
copy-js = true copy-js = true
``` ```
### Custom Renderers
A custom renderer can be enabled by adding a `[output.foo]` table to your
`book.toml`. Similar to [preprocessors](#configuring-preprocessors) this will
instruct `mdbook` to pass a representation of the book to `mdbook-foo` for
rendering.
Custom renderers will have access to all configuration within their table
(i.e. anything under `[output.foo]`), and the command to be invoked can be
manually specified with the `command` field.
## Environment Variables ## Environment Variables