NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
crates.io, #3240 most downloaded on crates.io
Creates a book from markdown files
Latest stable
0.5.4
Last release 4 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
Drag across the ruler to compare, or tap a release to open it.
See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-040 for a complete list of changes.
See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-040 for a complete list of changes.
--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).
#1244Your coding agent can read these notes before it upgrades. Set up the MCP server →
See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-037 for a complete list of changes.
See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-037 for a complete list of changes.
src directory, and
instead add a check that prevents infinite copies.
#1181
#1026See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-036 for a complete list of changes.
See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-036 for a complete list of changes.
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).
#1150See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-035 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-035 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-034 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-034 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-033 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-033 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-032 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-032 for a complete list of changes.
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.
#1070See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-031 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-031 for a complete list of changes.
language configuration value to set the language of the book, which
will affect things like the <html lang="en"> tag.
#941See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-030 for a complete list of changes.
See https://github.com/rust-lang-nursery/mdBook/blob/master/CHANGELOG.md#mdbook-030 for a complete list of changes.
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.
Fix table colors, broken by Stylus -> CSS transition
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 rel
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. 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.md)
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.
\{{#include file.rs}}) will now render correctly (f30ce01).index.html will now render correctly when the book's first section is inside a subdirectory (#756).This release has been yanked due to a regression introduced in 0.1.9. See the 0.1.9 release notes for more information.
This release has been yanked due to a regression introduced in 0.1.9. See the 0.1.9 release notes for more information.
mdBook was changed to use relative paths for links rather than the tag (#603). This change broke links defined using paths relative to the book root (
mdBook was changed to use relative paths for links rather than the <base> tag (#603). This change broke links defined using paths relative to the book root (#746). This release has been yanked to avoid breaking mdbook users who are relying on 0.1 compatibility. Please update to 0.2.0 to access the improvements from this release.
mdbook test (#741)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
Tests now emit a non zero exit-code when failing. Thanks @carols10cents
and are now correctly balanced in the TOC (Thanks @quornian )
<ul><li> and </li></ul> are now correctly balanced in the TOC (Thanks @quornian )%20)On windows links are now correctly rendered with / instead of \
/ instead of \Windows is now tested on new commits
Thanks to @japaric !
mdbook serve will watch for file changes and serve the rendered book to localhost:3000 (thanks to @Bobo1239)init the user is now asked if he wants a .gitignore to be created (thanks to @vrinek)Nothing published for this version
mdBook now has a beautiful favicon (thanks to @jessestricker) that can be overridden by placing a favicon.png file in the theme directory
favicon.png file in the theme directoryDisplay theme popup on top of the navigation arrows to make it possible again to change themes
modal menu for choosing the color theme is not nested inside the font-awesome tag anymore, the font is now the same as the rest of the page, so is the
<i> tag anymore, the font is now the same as the rest of the page, so is the text color. The "(default)" text is wrapped in a span block that is lighter than the theme name for better contrastIt is now possible to load rust files that are runnable with this syntax: {{#playpen file.rs}}. They will appear as normal code blocks but will have a
{{#playpen file.rs}}. They will appear as normal code blocks but will have a play button to run them.href attribute, this means that now when you click a heading you will be redirected to that anchor AND you will see the url to the anchor in the url bar. This was not the case before.# characters (used to hide rust code lines) where not removed if they were not the very first character of the linePath_Ext, use the version from STD that has been stabilizedfs::create_dir_all does the same thing as create_path but better. Is that instead and remove create_path. This resolves a bug where weird things would happen if you gave a path with .. in it.When navigating with the arrow keys, check if there is a next / previous page to avoid undefined > page not found
undefined > page not foundIt's a pretty annoying bug, so I want to publish the new version now..
You can now use inline code blocks in the sidebar #70
mdbook watch #61# #73mdbook test #69v0.0.2 uploaded to crates.io didn't compile anymore because dependency versions were not specified, this version fixes that.
v0.0.2 uploaded to crates.io didn't compile anymore because dependency versions were not specified, this version fixes that.
Crates.io Documentation
Crates.io Documentation
One column per quarter.