NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
crates.io · #3209 most downloaded on crates.io
Creates a book from markdown files
Last release 3 months ago
06 Jul 2026
Release timing varies
gaps range from 9 days to 5 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
7 versions withdrawn
withdrawn after publishing
11 years old
112 releases · first in 2015
Several of the changes in the release have altered the public API of the mdbook library.
--websocket-hostname and --websocket-port from
the serve command.
#1211site-url setting in the book
configuration so mdbook can generate the links correctly. Alternatively you
can disable the 404 page generation, or set up your own 404 handling in your
web server.
#1221debug and output features have been removed as they were unused.
#1211preferred-dark-theme config setting, as it now defaults to "navy".
#1199{{#playpen}} will now display warnings. This may
impact books that have modified the "playpen" elements in the theme.
#1241optional setting
for that renderer.
#1122[rust] configuration section to book.toml, which allows
setting the default edition with edition = "2018".
#1163optional, so that they will be ignored if
the renderer is not installed.
#1122head.hbs to allow adding content to the <head> section in HTML.
#1206SUMMARY.md to signify different sections.
#1171allow(unused_variables) to allow(unused).
#1195copy-fonts option was added to disable this if you want to supply your own
fonts.
#1188serve command to a new
implementation. This results in some internal differences in how websockets
are handled, which removes the separate websocket options. This should also
make it easier to serve multiple books at once.
#1211+ symbol should now work.
#1208MDBOOK_BOOK environment variable now correctly allows overriding the
entire book configuration.
#1207no_run code samples.
#1249--dest-dir command-line option for the serve and watch
commands.
#1228text input fields (for example, typing
S in a custom text input field).
#1244One column per quarter.
Code spans in headers are no longer highlighted as code. #1162
MDBook::execute_build_process is now publicly accessible in the API so that plugins can more easily initiate the build process. #1099
MDBook::execute_build_process is now publicly accessible in the API so
that plugins can more easily initiate the build process.
#1099<p>, <ul>, and <ol>.
#1136mdbook serve will retain the current scroll position when the page is reloaded.
#1097-.
#1145rel=next and rel=previous are now supported in "wide"
mode (previously they were only set in narrow mode).
#1150The default-theme config setting is now case-insensitive. #1079
Switch to relative rem font sizes from px. #894
Improvements to the automatic dark theme selection. #1069
Added a markdown renderer, which is off by default. This may be useful for debugging preprocessors. #1018
output.html.playpen.line-numbers configuration value.
#1035watch and serve commands will now ignore files listed in
.gitignore.
#1044prefers-color-scheme
feature. This may be enabled by setting output.html.preferred-dark-theme
to your preferred dark theme.
#1037rustdoc_include preprocessor. This makes it easier to include
portions of an external Rust source file. The rest of the file is hidden,
but the user may expand it to see the entire file, and will continue to work
with mdbook test.
#1003output.html.playpen.copyable configuration option to disable
the copy button.
#1050output.html.fold configuration to enable this feature.
#1027scrollbar-color CSS along with webkit extension
#816[output.html] config are no longer ignored.
#1033clean multiple times.
#1055inline-block for inline code, fixing selection highlighting
and some rendering issues.
#1058scrollTop.
#1070🔥 Added ability to include files using anchor points instead of line numbers. #851
Added ability to resize the sidebar. #849
load_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.
#871Added an optional button to the top of the page which will link to a git repository. Use the git-repository-url and git-repository-icon options in the
git-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
🎉 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.
Update to handlebars-rs 1.0 #761
💥 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 r
💥 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
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Your coding agent can read these notes before it upgrades. Set up the MCP server →