Breaking Changes

Links

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)

Commands

• 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.

Other Major Changes

• Escaped includes (\{{#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).
• Embedded rust playpens now use the "stable" playground API (#754).