Merge pull request #2940 from ehuss/bump-version

Update to 0.5.0

Author: ehuss

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 <https://rust-lang.github.io/mdBook/pre-release/>.
+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.

Cargo.lock

@@ -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 <[email protected]>",
     "Michael-F-Bryan <[email protected]>",

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

crates/mdbook-core/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

crates/mdbook-driver/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

crates/mdbook-html/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

crates/mdbook-markdown/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

crates/mdbook-preprocessor/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

crates/mdbook-renderer/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