From 262afdc2f8e0549238e0aedf4ddf849a0337a383 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Mon, 17 Nov 2025 08:57:52 -0800 Subject: [PATCH] Update to 0.5.0 This is the stable release of 0.5.0. No changes have been made since 0.5.0-beta.2. --- CHANGELOG.md | 26 ++++++++++++++++++++++++-- Cargo.lock | 16 ++++++++-------- Cargo.toml | 16 ++++++++-------- crates/mdbook-core/Cargo.toml | 2 +- crates/mdbook-driver/Cargo.toml | 2 +- crates/mdbook-html/Cargo.toml | 2 +- crates/mdbook-markdown/Cargo.toml | 2 +- crates/mdbook-preprocessor/Cargo.toml | 2 +- crates/mdbook-renderer/Cargo.toml | 2 +- crates/mdbook-summary/Cargo.toml | 2 +- 10 files changed, 47 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 058636b206..9d34664d17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,37 @@ # Changelog -## 0.5 Migration Guide +## mdBook 0.5.0 +[v0.4.52...v0.5.0](https://github.com/rust-lang/mdBook/compare/v0.4.52...v0.5.0) + +The 0.5.0 release is the next major release of mdBook, containing over 130 PRs since 0.4.52! The primary focus for this release has been an evolution of the Rust APIs to make it easier to maintain, to evolve in a backwards-compatible fashion, to clean up some things that have accumulated over time, and to significantly improve the performance and compile-times. + +This release also includes many new features described below. + +We have prepared a [0.5 Migration Guide](#05-migration-guide) to help existing authors switch from 0.4. -During the pre-release phase of the 0.5 release, the documentation may be found at . +The final 0.5.0 release does not contain any changes since [0.5.0-beta.2](#mdbook-050-beta2). + +## 0.5 Migration Guide The 0.5 release contains several breaking changes from the 0.4 release. Preprocessors and renderers will need to be migrated to continue to work with this release. After updating your configuration, it is recommended to carefully compare and review how your book renders to ensure everything is working correctly. If you have overridden any of the theme files, you will likely need to update them to match the current version. +See the entries below for [mdBook 0.5.0-alpha.1](#mdbook-050-alpha1), [mdBook 0.5.0-beta.1](#mdbook-050-beta1), and [mdBook 0.5.0-beta.2](#mdbook-050-beta2) for a more complete list of changes and fixes. + The following is a summary of the changes that may require your attention when updating to 0.5: +### Major additions + +- Added sidebar heading navigation. This includes the `output.html.sidebar-header-nav` option to disable it. + [#2822](https://github.com/rust-lang/mdBook/pull/2822) +- Added support for definition lists. These are enabled by default, with the option `output.html.definition-lists` to disable it. See [docs](https://rust-lang.github.io/mdBook/format/markdown.html#definition-lists) for more. + [#2847](https://github.com/rust-lang/mdBook/pull/2847) +- Added support for admonitions. These are enabled by default, with the option `output.html.admonitions` to disable it. See [docs](https://rust-lang.github.io/mdBook/format/markdown.html#admonitions) for more. + [#2851](https://github.com/rust-lang/mdBook/pull/2851) +- Links on the print page now link to elements on the print page instead of linking out to the individual chapters. + [#2844](https://github.com/rust-lang/mdBook/pull/2844) + ### Config changes - Unknown fields in config are now an error. diff --git a/Cargo.lock b/Cargo.lock index 23a2a10d6f..0b2956c173 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -956,7 +956,7 @@ checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" [[package]] name = "mdbook" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "axum", @@ -996,7 +996,7 @@ version = "0.0.0" [[package]] name = "mdbook-core" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "regex", @@ -1009,7 +1009,7 @@ dependencies = [ [[package]] name = "mdbook-driver" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "indexmap", @@ -1031,7 +1031,7 @@ dependencies = [ [[package]] name = "mdbook-html" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "ego-tree", @@ -1056,7 +1056,7 @@ dependencies = [ [[package]] name = "mdbook-markdown" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "pulldown-cmark", "regex", @@ -1065,7 +1065,7 @@ dependencies = [ [[package]] name = "mdbook-preprocessor" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "mdbook-core", @@ -1085,7 +1085,7 @@ dependencies = [ [[package]] name = "mdbook-renderer" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "mdbook-core", @@ -1095,7 +1095,7 @@ dependencies = [ [[package]] name = "mdbook-summary" -version = "0.5.0-beta.2" +version = "0.5.0" dependencies = [ "anyhow", "mdbook-core", diff --git a/Cargo.toml b/Cargo.toml index 1f2b77a4c6..4af6e7df99 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -39,13 +39,13 @@ hex = "0.4.3" html5ever = "0.35.0" indexmap = "2.12.0" ignore = "0.4.25" -mdbook-core = { path = "crates/mdbook-core", version = "0.5.0-beta.2" } -mdbook-driver = { path = "crates/mdbook-driver", version = "0.5.0-beta.2" } -mdbook-html = { path = "crates/mdbook-html", version = "0.5.0-beta.2" } -mdbook-markdown = { path = "crates/mdbook-markdown", version = "0.5.0-beta.2" } -mdbook-preprocessor = { path = "crates/mdbook-preprocessor", version = "0.5.0-beta.2" } -mdbook-renderer = { path = "crates/mdbook-renderer", version = "0.5.0-beta.2" } -mdbook-summary = { path = "crates/mdbook-summary", version = "0.5.0-beta.2" } +mdbook-core = { path = "crates/mdbook-core", version = "0.5.0" } +mdbook-driver = { path = "crates/mdbook-driver", version = "0.5.0" } +mdbook-html = { path = "crates/mdbook-html", version = "0.5.0" } +mdbook-markdown = { path = "crates/mdbook-markdown", version = "0.5.0" } +mdbook-preprocessor = { path = "crates/mdbook-preprocessor", version = "0.5.0" } +mdbook-renderer = { path = "crates/mdbook-renderer", version = "0.5.0" } +mdbook-summary = { path = "crates/mdbook-summary", version = "0.5.0" } memchr = "2.7.6" notify = "8.2.0" notify-debouncer-mini = "0.7.0" @@ -71,7 +71,7 @@ walkdir = "2.5.0" [package] name = "mdbook" -version = "0.5.0-beta.2" +version = "0.5.0" authors = [ "Mathieu David ", "Michael-F-Bryan ", diff --git a/crates/mdbook-core/Cargo.toml b/crates/mdbook-core/Cargo.toml index f331fb06f9..7ae55ddeb9 100644 --- a/crates/mdbook-core/Cargo.toml +++ b/crates/mdbook-core/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-core" -version = "0.5.0-beta.2" +version = "0.5.0" description = "The base support library for mdbook, intended for internal use only" edition.workspace = true license.workspace = true diff --git a/crates/mdbook-driver/Cargo.toml b/crates/mdbook-driver/Cargo.toml index 32f54db816..d37611dc99 100644 --- a/crates/mdbook-driver/Cargo.toml +++ b/crates/mdbook-driver/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-driver" -version = "0.5.0-beta.2" +version = "0.5.0" description = "High-level library for running mdBook" edition.workspace = true license.workspace = true diff --git a/crates/mdbook-html/Cargo.toml b/crates/mdbook-html/Cargo.toml index 6f884537e9..241c9d329d 100644 --- a/crates/mdbook-html/Cargo.toml +++ b/crates/mdbook-html/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-html" -version = "0.5.0-beta.2" +version = "0.5.0" description = "mdBook HTML renderer" edition.workspace = true license.workspace = true diff --git a/crates/mdbook-markdown/Cargo.toml b/crates/mdbook-markdown/Cargo.toml index 0b8b50deb6..38849ce423 100644 --- a/crates/mdbook-markdown/Cargo.toml +++ b/crates/mdbook-markdown/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-markdown" -version = "0.5.0-beta.2" +version = "0.5.0" description = "Markdown processing used in mdBook" edition.workspace = true license.workspace = true diff --git a/crates/mdbook-preprocessor/Cargo.toml b/crates/mdbook-preprocessor/Cargo.toml index b243b59274..f10634994d 100644 --- a/crates/mdbook-preprocessor/Cargo.toml +++ b/crates/mdbook-preprocessor/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-preprocessor" -version = "0.5.0-beta.2" +version = "0.5.0" description = "Library to assist implementing an mdBook preprocessor" edition.workspace = true license.workspace = true diff --git a/crates/mdbook-renderer/Cargo.toml b/crates/mdbook-renderer/Cargo.toml index 8b1cfed13a..8f422575ae 100644 --- a/crates/mdbook-renderer/Cargo.toml +++ b/crates/mdbook-renderer/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-renderer" -version = "0.5.0-beta.2" +version = "0.5.0" description = "Library to assist implementing an mdBook renderer" edition.workspace = true license.workspace = true diff --git a/crates/mdbook-summary/Cargo.toml b/crates/mdbook-summary/Cargo.toml index a3d23ef4ad..163d907ae0 100644 --- a/crates/mdbook-summary/Cargo.toml +++ b/crates/mdbook-summary/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mdbook-summary" -version = "0.5.0-beta.2" +version = "0.5.0" description = "Summary parser for mdBook" edition.workspace = true license.workspace = true