Documented new feature in manual

This commit is contained in:
Sytse Reitsma 2019-06-01 09:56:55 +02:00
parent f27c44cd5e
commit 5355d81939
1 changed files with 22 additions and 0 deletions

View File

@ -161,6 +161,10 @@ The following configuration options are available:
- **additional-js:** If you need to add some behaviour to your book without - **additional-js:** If you need to add some behaviour to your book without
removing the current behaviour, you can specify a set of JavaScript files that removing the current behaviour, you can specify a set of JavaScript files that
will be loaded alongside the default one. will be loaded alongside the default one.
- **additional-resources:** If you need to include some additional resources,
like for instance image files, that are located outside of the book
directory, you can specify one or more additional-resources sections to
include these.
- **no-section-label:** mdBook by defaults adds section label in table of - **no-section-label:** mdBook by defaults adds section label in table of
contents column. For example, "1.", "2.1". Set this option to true to disable contents column. For example, "1.", "2.1". Set this option to true to disable
those labels. Defaults to `false`. those labels. Defaults to `false`.
@ -172,6 +176,16 @@ The following configuration options are available:
- **git-repository-icon:** The FontAwesome icon class to use for the git - **git-repository-icon:** The FontAwesome icon class to use for the git
repository link. Defaults to `fa-github`. repository link. Defaults to `fa-github`.
Available configuration options for the `[[output.html.additional-resources]]`
table array:
- **output-dir:** The directory to copy the files to (relative to book output
directory). The directory is created recursively.
- **src:** The glob pattern to use when locating the additional resource files.
Note that the found files are flattened in the output dircetory, meaning the
original directory structure is lost.
Available configuration options for the `[output.html.playpen]` table: Available configuration options for the `[output.html.playpen]` table:
- **editable:** Allow editing the source code. Defaults to `false`. - **editable:** Allow editing the source code. Defaults to `false`.
@ -238,6 +252,14 @@ boost-paragraph = 1
expand = true expand = true
heading-split-level = 3 heading-split-level = 3
copy-js = true copy-js = true
[[output.html.additional-resources]]
output-dir="img"
src="../img/*.png"
[[output.html.additional-resources]]
output-dir="img/project"
src="../project/uml/*.png"
``` ```
### Custom Renderers ### Custom Renderers