From 5355d819399eb4dbc7b442d84ad9fd4709356f49 Mon Sep 17 00:00:00 2001 From: Sytse Reitsma Date: Sat, 1 Jun 2019 09:56:55 +0200 Subject: [PATCH] Documented new feature in manual --- book-example/src/format/config.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/book-example/src/format/config.md b/book-example/src/format/config.md index 3f40dcea..4d2fe6ff 100644 --- a/book-example/src/format/config.md +++ b/book-example/src/format/config.md @@ -161,6 +161,10 @@ The following configuration options are available: - **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 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 contents column. For example, "1.", "2.1". Set this option to true to disable 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 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: - **editable:** Allow editing the source code. Defaults to `false`. @@ -238,6 +252,14 @@ boost-paragraph = 1 expand = true heading-split-level = 3 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