From 6d6e5407a3a46addea126199f262e57ccdc65dbf Mon Sep 17 00:00:00 2001 From: Manuel Woelker Date: Wed, 10 Jun 2020 12:46:05 +0200 Subject: [PATCH] document: config 404 config parameters `output.html.site-url` and `output.html.site-url` --- book-example/src/format/config.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/book-example/src/format/config.md b/book-example/src/format/config.md index 4178660b..ea2c2c3b 100644 --- a/book-example/src/format/config.md +++ b/book-example/src/format/config.md @@ -204,6 +204,12 @@ The following configuration options are available: `/appendices/bibliography.html`). The value can be any valid URI the browser should navigate to (e.g. `https://rust-lang.org/`, `/overview.html`, or `../bibliography.html`). +- **input-404:** The name of the markdown file used for misssing files. + The corresponding output file will be the same, with the extension replaced with `html`. + Defaults to `404.md`. +- **site-url:** The url where the book will be hosted. This is required to ensure + navigation links and script/css imports in the 404 file work correctly, even when accessing + urls in subdirectories. Defaults to `/`. Available configuration options for the `[output.html.fold]` table: @@ -266,6 +272,8 @@ additional-js = ["custom.js"] no-section-label = false git-repository-url = "https://github.com/rust-lang/mdBook" git-repository-icon = "fa-github" +site-url = "/example-book/" +input-404 = "not-found.md" [output.html.fold] enable = false