Skip to content

Releases: rust-lang/mdBook

v0.2.0

Choose a tag to compare

@Michael-F-Bryan Michael-F-Bryan released this 03 Aug 00:37
v0.2.0
91ffca1

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

v0.1.10 (yanked)

v0.1.10 (yanked) Pre-release
Pre-release

Choose a tag to compare

@mattico mattico released this 31 Jul 00:45
v0.1.10
add23a4

Known Regression

This release has been yanked due to a regression introduced in 0.1.9. See the 0.1.9 release notes for more information.

Major Changes

  • Convert Stylus to CSS (#743)
  • Fix runnable Rust code blocks not executing (#751)
  • Remove hit-test dead-space between menu icon buttons (#752)

v0.1.9 (yanked)

v0.1.9 (yanked) Pre-release
Pre-release

Choose a tag to compare

@mattico mattico released this 26 Jul 18:16
v0.1.9
2bbabdc

Known Regression

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.

Major Changes

  • Improve search index size, and make it load asynchronously (#707)
  • Disable the request to crates.io for the list of crates except on pages which have a rust playpen (#709)
  • Use the same font size for editable and static code blocks (#710)
  • Allow escaping the hash character, used for hiding lines of Rust doc examples (#719)
  • Fix mdbook test (#741)

v0.1.8

Choose a tag to compare

@mattico mattico released this 24 Jul 19:59
v0.1.8
b9ff0e8
(cargo-release) v version 0.1.8

v0.1.7

Choose a tag to compare

@mattico mattico released this 24 Jul 20:05
v0.1.7
ea0b835
(cargo-release) v version 0.1.7

v0.1.6

Choose a tag to compare

@mattico mattico released this 24 Jul 20:05
v0.1.6
(cargo-release) v version 0.1.6

v0.1.5

Choose a tag to compare

@Michael-F-Bryan Michael-F-Bryan released this 15 Mar 23:49
v0.1.5
6308da6
(cargo-release) v version 0.1.5

v0.1.4

Choose a tag to compare

@Michael-F-Bryan Michael-F-Bryan released this 15 Mar 01:37
v0.1.4
c8bbfd4
(cargo-release) v version 0.1.4

v0.1.3

Choose a tag to compare

@Michael-F-Bryan Michael-F-Bryan released this 16 Feb 00:15
v0.1.3
b765023
(cargo-release) v version 0.1.3

v0.1.2

Choose a tag to compare

@Michael-F-Bryan Michael-F-Bryan released this 31 Jan 11:31
v0.1.2
7181993
(cargo-release) v version 0.1.2