|
1 | 1 | # Changelog |
2 | 2 |
|
3 | 3 | ## mdBook 0.4.0 |
4 | | -[99ecd4f...HEAD](https://github.com/rust-lang/mdBook/compare/99ecd4f...HEAD) |
| 4 | +[99ecd4f...d4df7e7](https://github.com/rust-lang/mdBook/compare/99ecd4f...d4df7e7) |
| 5 | + |
| 6 | +### Breaking Changes |
| 7 | +- Several of the changes in the release have altered the public API of the |
| 8 | + mdbook library. |
| 9 | +- Many dependencies have been updated or replaced. |
| 10 | + This also removes the `--websocket-hostname` and `--websocket-port` from |
| 11 | + the `serve` command. |
| 12 | + [#1211](https://github.com/rust-lang/mdBook/pull/1211) |
| 13 | +- A new "404" page is now automatically rendered. This requires knowledge of |
| 14 | + the base URL of your site to work properly. If you decide to use this as |
| 15 | + your 404 page, you should set the `site-url` setting in the book |
| 16 | + configuration so mdbook can generate the links correctly. Alternatively you |
| 17 | + can disable the 404 page generation, or set up your own 404 handling in your |
| 18 | + web server. |
| 19 | + [#1221](https://github.com/rust-lang/mdBook/pull/1221) |
| 20 | +- If you are using customized themes, you may want to consider setting the |
| 21 | + `preferred-dark-theme` config setting, as it now defaults to "navy". |
| 22 | + [#1199](https://github.com/rust-lang/mdBook/pull/1199) |
| 23 | +- "Playpen" has been renamed to "playground". This is generally backwards |
| 24 | + compatible for users, but `{{#playpen}}` will now display warnings. This may |
| 25 | + impact books that have modified the "playpen" elements in the theme. |
| 26 | + [#1241](https://github.com/rust-lang/mdBook/pull/1241) |
| 27 | +- If a renderer is not installed, it is now treated as an error. If you want |
| 28 | + the old behavior of ignoring missing renderers, set the `optional` setting |
| 29 | + for that renderer. |
| 30 | + [#1122](https://github.com/rust-lang/mdBook/pull/1122) |
5 | 31 |
|
| 32 | +### Added |
| 33 | +- Added a new `[rust]` configuration section to `book.toml`, which allows |
| 34 | + setting the default edition with `edition = "2018"`. |
| 35 | + [#1163](https://github.com/rust-lang/mdBook/pull/1163) |
| 36 | +- Renderers can now be marked as `optional`, so that they will be ignored if |
| 37 | + the renderer is not installed. |
| 38 | + [#1122](https://github.com/rust-lang/mdBook/pull/1122) |
| 39 | +- Added `head.hbs` to allow adding content to the `<head>` section in HTML. |
| 40 | + [#1206](https://github.com/rust-lang/mdBook/pull/1206) |
| 41 | +- Added "draft chapters". These are chapters listed without a link to indicate |
| 42 | + content yet to be written. |
| 43 | + [#1153](https://github.com/rust-lang/mdBook/pull/1153) |
| 44 | +- Added "parts" to split a book into different sections. Headers can be added |
| 45 | + to `SUMMARY.md` to signify different sections. |
| 46 | + [#1171](https://github.com/rust-lang/mdBook/pull/1171) |
| 47 | +- Added generation of a "404" page for handling missing pages and broken links. |
| 48 | + [#1221](https://github.com/rust-lang/mdBook/pull/1221) |
| 49 | +- Added configuration section for specifying URL redirects. |
| 50 | + [#1237](https://github.com/rust-lang/mdBook/pull/1237) |
| 51 | +- Added an SVG favicon that works with light and dark colors schemes. |
| 52 | + [#1230](https://github.com/rust-lang/mdBook/pull/1230) |
| 53 | + |
| 54 | +### Changed |
| 55 | +- Changed default Rust attribute of `allow(unused_variables)` to `allow(unused)`. |
| 56 | + [#1195](https://github.com/rust-lang/mdBook/pull/1195) |
| 57 | +- Fonts are now served locally instead of from the Google Fonts CDN. The |
| 58 | + `copy-fonts` option was added to disable this if you want to supply your own |
| 59 | + fonts. |
| 60 | + [#1188](https://github.com/rust-lang/mdBook/pull/1188) |
| 61 | +- Switched the built-in webserver for the `serve` command to a new |
| 62 | + implementation. This results in some internal differences in how websockets |
| 63 | + are handled, which removes the separate websocket options. This should also |
| 64 | + make it easier to serve multiple books at once. |
| 65 | + [#1211](https://github.com/rust-lang/mdBook/pull/1211) |
| 66 | +- The default dark theme is now "navy". |
| 67 | + [#1199](https://github.com/rust-lang/mdBook/pull/1199) |
| 68 | +- "Playpen" has been renamed to "playground", matching the actual name of the |
| 69 | + service which was renamed many years ago. |
| 70 | + [#1241](https://github.com/rust-lang/mdBook/pull/1241) |
| 71 | + |
| 72 | +### Fixed |
| 73 | +- Links with the `+` symbol should now work. |
| 74 | + [#1208](https://github.com/rust-lang/mdBook/pull/1208) |
| 75 | +- The `MDBOOK_BOOK` environment variable now correctly allows overriding the |
| 76 | + entire book configuration. |
| 77 | + [#1207](https://github.com/rust-lang/mdBook/pull/1207) |
| 78 | +- The sidebar can no longer be dragged outside of the window. |
| 79 | + [#1229](https://github.com/rust-lang/mdBook/pull/1229) |
| 80 | +- Hide the Rust Playground "play" button for `no_run` code samples. |
| 81 | + [#1249](https://github.com/rust-lang/mdBook/pull/1249) |
| 82 | +- Fixed the `--dest-dir` command-line option for the `serve` and `watch` |
| 83 | + commands. |
| 84 | + [#1228](https://github.com/rust-lang/mdBook/pull/1228) |
| 85 | +- Hotkey handlers are now disabled in `text` input fields (for example, typing |
| 86 | + `S` in a custom text input field). |
| 87 | + [#1244](https://github.com/rust-lang/mdBook/pull/1244) |
6 | 88 |
|
7 | 89 | ## mdBook 0.3.7 |
8 | 90 | [88684d8...99ecd4f](https://github.com/rust-lang/mdBook/compare/88684d8...99ecd4f) |
|
0 commit comments