11# Changelog
22
3- ### 0.5 Migration Guide
3+ ## 0.5 Migration Guide
44
55During the pre-release phase of the 0.5 release, the documentation may be found at < https://rust-lang.github.io/mdBook/pre-release/ > .
66
@@ -10,7 +10,7 @@ If you have overridden any of the theme files, you will likely need to update th
1010
1111The following is a summary of the changes that may require your attention when updating to 0.5:
1212
13- #### Config changes
13+ ### Config changes
1414
1515- Unknown fields in config are now an error.
1616 [ #2787 ] ( https://github.com/rust-lang/mdBook/pull/2787 )
@@ -35,14 +35,14 @@ The following is a summary of the changes that may require your attention when u
3535- Removed the very old legacy config support. Warnings have been displayed in previous versions on how to migrate.
3636 [ #2783 ] ( https://github.com/rust-lang/mdBook/pull/2783 )
3737
38- #### Theme changes
38+ ### Theme changes
3939
4040- Replaced the ` {{#previous}} ` and ` {{#next}} ` handlebars helpers with simple objects that contain the previous and next values.
4141 [ #2794 ] ( https://github.com/rust-lang/mdBook/pull/2794 )
4242- Removed the ` {{theme_option}} ` handlebars helper. It has not been used for a while.
4343 [ #2795 ] ( https://github.com/rust-lang/mdBook/pull/2795 )
4444
45- #### Rendering changes
45+ ### Rendering changes
4646
4747- Updated to a newer version of ` pulldown-cmark ` . This brings a large number of fixes to markdown processing.
4848 [ #2401 ] ( https://github.com/rust-lang/mdBook/pull/2401 )
@@ -59,14 +59,14 @@ The following is a summary of the changes that may require your attention when u
5959- Added support for admonitions. These are enabled by default, with the option ` output.html.admonitions ` to disable it.
6060 [ #2851 ] ( https://github.com/rust-lang/mdBook/pull/2851 )
6161
62- #### CLI changes
62+ ### CLI changes
6363
6464- Removed the ` --dest-dir ` option to ` mdbook test ` . It was unused since ` mdbook test ` does not generate output.
6565 [ #2805 ] ( https://github.com/rust-lang/mdBook/pull/2805 )
6666- Changed CLI ` --dest-dir ` to be relative to the current directory, not the book root.
6767 [ #2806 ] ( https://github.com/rust-lang/mdBook/pull/2806 )
6868
69- #### Rust API
69+ ### Rust API
7070
7171- The Rust API has been split into several crates ([ #2766 ] ( https://github.com/rust-lang/mdBook/pull/2766 ) ). In summary, the different crates are:
7272 - ` mdbook ` — The CLI binary.
@@ -102,6 +102,29 @@ The following is a summary of the changes that may require your attention when u
102102- Various functions in the ` utils::fs ` module have been removed, renamed, or reworked.
103103- Most of the functions in the ` utils ` module have been moved, removed, or made private.
104104
105+ ## mdBook 0.5.0-beta.1
106+ [ v0.5.0-alpha.1...v0.5.0-beta.1] ( https://github.com/rust-lang/mdBook/compare/v0.5.0-alpha.1...v0.5.0-beta.1 )
107+
108+ ### Changed
109+
110+ - Reworked the look of the header navigation.
111+ [ #2898 ] ( https://github.com/rust-lang/mdBook/pull/2898 )
112+ - Update cargo dependencies.
113+ [ #2896 ] ( https://github.com/rust-lang/mdBook/pull/2896 )
114+ - Improved the heading nav debug.
115+ [ #2892 ] ( https://github.com/rust-lang/mdBook/pull/2892 )
116+
117+ ### Fixed
118+
119+ - Fixed error message for config.get deserialization error.
120+ [ #2902 ] ( https://github.com/rust-lang/mdBook/pull/2902 )
121+ - Filter ` <mark> ` tags from sidebar heading nav.
122+ [ #2899 ] ( https://github.com/rust-lang/mdBook/pull/2899 )
123+ - Avoid divide-by-zero in heading nav computation
124+ [ #2891 ] ( https://github.com/rust-lang/mdBook/pull/2891 )
125+ - Fixed heading nav with folded chapters.
126+ [ #2893 ] ( https://github.com/rust-lang/mdBook/pull/2893 )
127+
105128## mdBook 0.5.0-alpha.1
106129[ v0.4.52...v0.5.0-alpha.1] ( https://github.com/rust-lang/mdBook/compare/v0.4.52...v0.5.0-alpha.1 )
107130
0 commit comments