language
configuration value to set the language of the book, which will affect things like the <html lang="en">
tag. #941load_with_config_and_summary
function to MDBook
to be able to build a book with a custom Summary
. #883noindex
on print.html
page to prevent robots from indexing it. #844same-file
crate. #903with_preprecessor
to with_preprocessor
. #906diff
language should now highlight correctly. #943mdbook serve
only reloads once when multiple files are changed at once. #870additional-js
files. #796code spans
that are links. #905file
urls. #915SUMMARY.md
in mdbook init
. #841print.html
. #871git-repository-url
and git-repository-icon
options in the [output.html]
section to enable it and set its appearance. #802default-theme
option to the [output.html]
section. #804a
character for headers that start with a non-ascii-alphabetic character. #788🎉 Process-based custom preprocessors. See the docs for more. #792
🎉 Configurable preprocessors.
Added build.use-default-preprocessors
boolean TOML key to allow disabling the built-in links
and index
preprocessors.
Added [preprocessor]
TOML tables to configure each preprocessor.
Specifying [preprocessor.links]
or [preprocessor.index]
will enable the respective built-in preprocessor if build.use-default-preprocessors
is false
.
Added fn supports_renderer(&self, renderer: &str) -> bool
to the Preprocessor
trait to specify if the preprocessor supports the given renderer. The default implementation always returns true
.
Preprocessor::run
now takes a book by value instead of a mutable reference. It should return a Book
value with the intended modifications.
Added PreprocessorContext::renderer
to indicate the renderer being used.
💥 This release changes how links are handled in mdBook. Previously, relative links were interpreted relative to the book's root. In 0.2.0
+ links are relative to the page they are in, and use the .md
extension. This has several advantages, such as making links work in other markdown viewers like GitHub. You will likely have to change links in your book to accommodate this change. For example, a book with this layout:
chapter_1/ section_1.md section_2.md SUMMARY.md
Previously a link in section_1.md
to section_2.md
would look like this:
[section_2](chapter_1/section_2.html)
Now it must be changed to this:
[section_2](section_2.md)
💥 mdbook test --library-path
now accepts a comma-delimited list of arguments rather than taking all following arguments. This makes it easier to handle the trailing book directory argument without always needing to put --
before it. Multiple instances of the option continue to be accepted: mdbook test -L foo -L bar
.
💥 mdbook serve
has some of its options renamed for clarity. See mdbook help serve
for details.
Embedded rust playpens now use the “stable” playground API. #754