actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Redid the wording in the docs because it was around the wrong way

This commit is contained in:
Michael-F-Bryan 2020-05-30 04:09:43 +08:00
parent 5907caa732
commit 964a10ff29
No known key found for this signature in database
GPG Key ID: E9C602B0D9A998DC
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
book-example/src/format/config.md
View File

@ -199,9 +199,11 @@ 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`.
- **redirect:** A subtable used for generating redirects when a page is moved. - **redirect:** A subtable used for generating redirects when a page is moved.
The table contains key-value pairs where the key is the path to the moved The table contains key-value pairs where the key is where the redirect file
page, relative to the build directory and the value can be an ordinary URL needs to be created, as an absolute path from the build directory, (e.g.
or the *absolute* path to another page in the book `/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`).
Available configuration options for the `[output.html.fold]` table: Available configuration options for the `[output.html.fold]` table:
@ -287,8 +289,8 @@ heading-split-level = 3
copy-js = true copy-js = true
[output.html.redirect] [output.html.redirect]
"other-installation-methods.html" = "/infra/other-installation-methods.html" /appendices/"bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html"
"bibliography.html" = "https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html" "/other-installation-methods.html" = "../infra/other-installation-methods.html"
``` ```
### Markdown Renderer ### Markdown Renderer