Skip to content

Releases: rust-lang/mdBook

v0.3.0

18 Jun 23:33
69a08ef
Compare
Choose a tag to compare

v0.2.1

22 Aug 14:04
v0.2.1
7e2e095
Compare
Choose a tag to compare
  • Update to handlebars-rs 1.0 (#761)
  • Fix table colors, broken by Stylus -> CSS transition (#765)

v0.2.0

03 Aug 00:37
v0.2.0
91ffca1
Compare
Choose a tag to compare

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)

31 Jul 00:45
v0.1.10
add23a4
Compare
Choose a tag to compare
v0.1.10 (yanked) Pre-release
Pre-release

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)

26 Jul 18:16
v0.1.9
2bbabdc
Compare
Choose a tag to compare
v0.1.9 (yanked) Pre-release
Pre-release

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

24 Jul 19:59
v0.1.8
b9ff0e8
Compare
Choose a tag to compare
(cargo-release) v version 0.1.8

v0.1.7

24 Jul 20:05
v0.1.7
ea0b835
Compare
Choose a tag to compare
(cargo-release) v version 0.1.7

v0.1.6

24 Jul 20:05
v0.1.6
Compare
Choose a tag to compare
(cargo-release) v version 0.1.6

v0.1.5

15 Mar 23:49
v0.1.5
6308da6
Compare
Choose a tag to compare
(cargo-release) v version 0.1.5

v0.1.4

15 Mar 01:37
v0.1.4
c8bbfd4
Compare
Choose a tag to compare
(cargo-release) v version 0.1.4