2019-05-19 05:56:01 +08:00
|
|
|
# Changelog
|
|
|
|
|
|
2020-07-03 23:52:27 +08:00
|
|
|
## mdBook 0.4.1
|
|
|
|
|
[d4df7e7...649f355](https://github.com/rust-lang/mdBook/compare/d4df7e7...649f355)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Removed several outdated dev-dependencies.
|
|
|
|
|
[#1267](https://github.com/rust-lang/mdBook/pull/1267)
|
|
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed sidebar scrolling if the book includes part titles.
|
|
|
|
|
[#1265](https://github.com/rust-lang/mdBook/pull/1265)
|
|
|
|
|
- Don't include the default favicon if only one of the PNG or SVG is overridden.
|
|
|
|
|
[#1266](https://github.com/rust-lang/mdBook/pull/1266)
|
|
|
|
|
|
2020-04-21 00:44:18 +08:00
|
|
|
## mdBook 0.4.0
|
2020-06-24 02:44:05 +08:00
|
|
|
[99ecd4f...d4df7e7](https://github.com/rust-lang/mdBook/compare/99ecd4f...d4df7e7)
|
2020-04-21 00:44:18 +08:00
|
|
|
|
2020-06-24 02:44:05 +08:00
|
|
|
### Breaking Changes
|
|
|
|
|
- Several of the changes in the release have altered the public API of the
|
|
|
|
|
mdbook library.
|
|
|
|
|
- Many dependencies have been updated or replaced.
|
|
|
|
|
This also removes the `--websocket-hostname` and `--websocket-port` from
|
|
|
|
|
the `serve` command.
|
|
|
|
|
[#1211](https://github.com/rust-lang/mdBook/pull/1211)
|
|
|
|
|
- A new "404" page is now automatically rendered. This requires knowledge of
|
|
|
|
|
the base URL of your site to work properly. If you decide to use this as
|
|
|
|
|
your 404 page, you should set the `site-url` setting in the book
|
|
|
|
|
configuration so mdbook can generate the links correctly. Alternatively you
|
|
|
|
|
can disable the 404 page generation, or set up your own 404 handling in your
|
|
|
|
|
web server.
|
|
|
|
|
[#1221](https://github.com/rust-lang/mdBook/pull/1221)
|
|
|
|
|
- If you are using customized themes, you may want to consider setting the
|
|
|
|
|
`preferred-dark-theme` config setting, as it now defaults to "navy".
|
|
|
|
|
[#1199](https://github.com/rust-lang/mdBook/pull/1199)
|
|
|
|
|
- "Playpen" has been renamed to "playground". This is generally backwards
|
|
|
|
|
compatible for users, but `{{#playpen}}` will now display warnings. This may
|
|
|
|
|
impact books that have modified the "playpen" elements in the theme.
|
|
|
|
|
[#1241](https://github.com/rust-lang/mdBook/pull/1241)
|
|
|
|
|
- If a renderer is not installed, it is now treated as an error. If you want
|
|
|
|
|
the old behavior of ignoring missing renderers, set the `optional` setting
|
|
|
|
|
for that renderer.
|
|
|
|
|
[#1122](https://github.com/rust-lang/mdBook/pull/1122)
|
2020-06-28 06:37:13 +08:00
|
|
|
- If you have a custom favicon, you may need to look into adding an SVG
|
|
|
|
|
version, otherwise the default SVG icon will be displayed.
|
|
|
|
|
[#1230](https://github.com/rust-lang/mdBook/pull/1230)
|
2020-06-24 02:44:05 +08:00
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- Added a new `[rust]` configuration section to `book.toml`, which allows
|
|
|
|
|
setting the default edition with `edition = "2018"`.
|
|
|
|
|
[#1163](https://github.com/rust-lang/mdBook/pull/1163)
|
|
|
|
|
- Renderers can now be marked as `optional`, so that they will be ignored if
|
|
|
|
|
the renderer is not installed.
|
|
|
|
|
[#1122](https://github.com/rust-lang/mdBook/pull/1122)
|
|
|
|
|
- Added `head.hbs` to allow adding content to the `<head>` section in HTML.
|
|
|
|
|
[#1206](https://github.com/rust-lang/mdBook/pull/1206)
|
|
|
|
|
- Added "draft chapters". These are chapters listed without a link to indicate
|
|
|
|
|
content yet to be written.
|
|
|
|
|
[#1153](https://github.com/rust-lang/mdBook/pull/1153)
|
|
|
|
|
- Added "parts" to split a book into different sections. Headers can be added
|
|
|
|
|
to `SUMMARY.md` to signify different sections.
|
|
|
|
|
[#1171](https://github.com/rust-lang/mdBook/pull/1171)
|
|
|
|
|
- Added generation of a "404" page for handling missing pages and broken links.
|
|
|
|
|
[#1221](https://github.com/rust-lang/mdBook/pull/1221)
|
|
|
|
|
- Added configuration section for specifying URL redirects.
|
|
|
|
|
[#1237](https://github.com/rust-lang/mdBook/pull/1237)
|
|
|
|
|
- Added an SVG favicon that works with light and dark colors schemes.
|
|
|
|
|
[#1230](https://github.com/rust-lang/mdBook/pull/1230)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Changed default Rust attribute of `allow(unused_variables)` to `allow(unused)`.
|
|
|
|
|
[#1195](https://github.com/rust-lang/mdBook/pull/1195)
|
|
|
|
|
- Fonts are now served locally instead of from the Google Fonts CDN. The
|
|
|
|
|
`copy-fonts` option was added to disable this if you want to supply your own
|
|
|
|
|
fonts.
|
|
|
|
|
[#1188](https://github.com/rust-lang/mdBook/pull/1188)
|
|
|
|
|
- Switched the built-in webserver for the `serve` command to a new
|
|
|
|
|
implementation. This results in some internal differences in how websockets
|
|
|
|
|
are handled, which removes the separate websocket options. This should also
|
|
|
|
|
make it easier to serve multiple books at once.
|
|
|
|
|
[#1211](https://github.com/rust-lang/mdBook/pull/1211)
|
|
|
|
|
- The default dark theme is now "navy".
|
|
|
|
|
[#1199](https://github.com/rust-lang/mdBook/pull/1199)
|
|
|
|
|
- "Playpen" has been renamed to "playground", matching the actual name of the
|
|
|
|
|
service which was renamed many years ago.
|
|
|
|
|
[#1241](https://github.com/rust-lang/mdBook/pull/1241)
|
|
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Links with the `+` symbol should now work.
|
|
|
|
|
[#1208](https://github.com/rust-lang/mdBook/pull/1208)
|
|
|
|
|
- The `MDBOOK_BOOK` environment variable now correctly allows overriding the
|
|
|
|
|
entire book configuration.
|
|
|
|
|
[#1207](https://github.com/rust-lang/mdBook/pull/1207)
|
|
|
|
|
- The sidebar can no longer be dragged outside of the window.
|
|
|
|
|
[#1229](https://github.com/rust-lang/mdBook/pull/1229)
|
|
|
|
|
- Hide the Rust Playground "play" button for `no_run` code samples.
|
|
|
|
|
[#1249](https://github.com/rust-lang/mdBook/pull/1249)
|
|
|
|
|
- Fixed the `--dest-dir` command-line option for the `serve` and `watch`
|
|
|
|
|
commands.
|
|
|
|
|
[#1228](https://github.com/rust-lang/mdBook/pull/1228)
|
|
|
|
|
- Hotkey handlers are now disabled in `text` input fields (for example, typing
|
|
|
|
|
`S` in a custom text input field).
|
|
|
|
|
[#1244](https://github.com/rust-lang/mdBook/pull/1244)
|
2020-04-21 00:44:18 +08:00
|
|
|
|
2020-04-04 03:55:41 +08:00
|
|
|
## mdBook 0.3.7
|
|
|
|
|
[88684d8...99ecd4f](https://github.com/rust-lang/mdBook/compare/88684d8...99ecd4f)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Code spans in headers are no longer highlighted as code.
|
|
|
|
|
[#1162](https://github.com/rust-lang/mdBook/pull/1162)
|
|
|
|
|
- The sidebar will now scroll the activate page to the middle instead of the top.
|
|
|
|
|
[#1161](https://github.com/rust-lang/mdBook/pull/1161)
|
|
|
|
|
- Reverted change to reject build output within the `src` directory, and
|
|
|
|
|
instead add a check that prevents infinite copies.
|
|
|
|
|
[#1181](https://github.com/rust-lang/mdBook/pull/1181)
|
|
|
|
|
[#1026](https://github.com/rust-lang/mdBook/pull/1026)
|
|
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed sidebar line-height jumping for collapsed chapters.
|
|
|
|
|
[#1182](https://github.com/rust-lang/mdBook/pull/1182)
|
|
|
|
|
- Fixed theme selector focus.
|
|
|
|
|
[#1170](https://github.com/rust-lang/mdBook/pull/1170)
|
|
|
|
|
|
2020-03-20 03:43:22 +08:00
|
|
|
## mdBook 0.3.6
|
|
|
|
|
[efdb832...88684d8](https://github.com/rust-lang/mdBook/compare/efdb832...88684d8)
|
|
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- `MDBook::execute_build_process` is now publicly accessible in the API so
|
|
|
|
|
that plugins can more easily initiate the build process.
|
|
|
|
|
[#1099](https://github.com/rust-lang/mdBook/pull/1099)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Use a different color for Ayu theme's highlighting for Rust attributes (uses
|
|
|
|
|
a bright color instead of the comment color).
|
|
|
|
|
[#1133](https://github.com/rust-lang/mdBook/pull/1133)
|
|
|
|
|
- Adjusted spacing of sidebar entries.
|
|
|
|
|
[#1137](https://github.com/rust-lang/mdBook/pull/1137)
|
|
|
|
|
- Slightly adjusted line-height of `<p>`, `<ul>`, and `<ol>`.
|
|
|
|
|
[#1136](https://github.com/rust-lang/mdBook/pull/1136)
|
|
|
|
|
- Handlebars updated to 3.0.
|
|
|
|
|
[#1130](https://github.com/rust-lang/mdBook/pull/1130)
|
|
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fix an issue with sidebar scroll position on reload.
|
|
|
|
|
[#1108](https://github.com/rust-lang/mdBook/pull/1108)
|
|
|
|
|
- `mdbook serve` will retain the current scroll position when the page is reloaded.
|
|
|
|
|
[#1097](https://github.com/rust-lang/mdBook/pull/1097)
|
|
|
|
|
- Fixed the page name if the book didn't have a title to not be prefixed with ` - `.
|
|
|
|
|
[#1145](https://github.com/rust-lang/mdBook/pull/1145)
|
|
|
|
|
- HTML attributes `rel=next` and `rel=previous` are now supported in "wide"
|
|
|
|
|
mode (previously they were only set in narrow mode).
|
|
|
|
|
[#1150](https://github.com/rust-lang/mdBook/pull/1150)
|
|
|
|
|
- Prevent recursive copies when the destination directory is contained in the
|
|
|
|
|
source directory.
|
|
|
|
|
[#1135](https://github.com/rust-lang/mdBook/pull/1135)
|
|
|
|
|
- Adjusted the menu bar animation to not immediately obscure the top content.
|
|
|
|
|
[#989](https://github.com/rust-lang/mdBook/pull/989)
|
|
|
|
|
- Fix for comments in SUMMARY.md that appear between items.
|
|
|
|
|
[#1167](https://github.com/rust-lang/mdBook/pull/1167)
|
|
|
|
|
|
2019-11-12 05:36:13 +08:00
|
|
|
## mdBook 0.3.5
|
|
|
|
|
[6e0d0fa...efdb832](https://github.com/rust-lang/mdBook/compare/6e0d0fa...efdb832)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- The `default-theme` config setting is now case-insensitive.
|
|
|
|
|
[#1079](https://github.com/rust-lang/mdBook/pull/1079)
|
|
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed `#` hidden Rust code lines not rendering properly.
|
|
|
|
|
[#1088](https://github.com/rust-lang/mdBook/pull/1088)
|
|
|
|
|
- Updated pulldown-cmark to 0.6.1, fixing several issues.
|
|
|
|
|
[#1021](https://github.com/rust-lang/mdBook/pull/1021)
|
|
|
|
|
|
2019-10-30 00:58:11 +08:00
|
|
|
## mdBook 0.3.4
|
|
|
|
|
[e5f77aa...6e0d0fa](https://github.com/rust-lang/mdBook/compare/e5f77aa...6e0d0fa)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Switch to relative `rem` font sizes from `px`.
|
|
|
|
|
[#894](https://github.com/rust-lang/mdBook/pull/894)
|
|
|
|
|
- Migrated repository to https://github.com/rust-lang/mdBook/
|
|
|
|
|
[#1083](https://github.com/rust-lang/mdBook/pull/1083)
|
|
|
|
|
|
2019-10-27 03:16:23 +08:00
|
|
|
## mdBook 0.3.3
|
2019-10-29 21:04:16 +08:00
|
|
|
[2b649fe...e5f77aa](https://github.com/rust-lang/mdBook/compare/2b649fe...e5f77aa)
|
2019-10-27 03:16:23 +08:00
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Improvements to the automatic dark theme selection.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1069](https://github.com/rust-lang/mdBook/pull/1069)
|
2019-10-27 03:16:23 +08:00
|
|
|
- Fragment links now prevent scrolling the header behind the menu bar.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1077](https://github.com/rust-lang/mdBook/pull/1077)
|
2019-10-27 03:16:23 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed error when building a book that has a spacer immediately after the
|
|
|
|
|
first chapter.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1075](https://github.com/rust-lang/mdBook/pull/1075)
|
2019-10-27 03:16:23 +08:00
|
|
|
|
2019-10-22 02:41:39 +08:00
|
|
|
## mdBook 0.3.2
|
2019-10-29 21:04:16 +08:00
|
|
|
[9cd47eb...2b649fe](https://github.com/rust-lang/mdBook/compare/9cd47eb...2b649fe)
|
2019-10-22 02:41:39 +08:00
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- Added a markdown renderer, which is off by default. This may be useful for
|
|
|
|
|
debugging preprocessors.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1018](https://github.com/rust-lang/mdBook/pull/1018)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Code samples may now include line numbers with the
|
|
|
|
|
`output.html.playpen.line-numbers` configuration value.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1035](https://github.com/rust-lang/mdBook/pull/1035)
|
2019-10-22 02:41:39 +08:00
|
|
|
- The `watch` and `serve` commands will now ignore files listed in
|
|
|
|
|
`.gitignore`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1044](https://github.com/rust-lang/mdBook/pull/1044)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Added automatic dark-theme detection based on the CSS `prefers-color-scheme`
|
|
|
|
|
feature. This may be enabled by setting `output.html.preferred-dark-theme`
|
|
|
|
|
to your preferred dark theme.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1037](https://github.com/rust-lang/mdBook/pull/1037)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Added `rustdoc_include` preprocessor. This makes it easier to include
|
|
|
|
|
portions of an external Rust source file. The rest of the file is hidden,
|
|
|
|
|
but the user may expand it to see the entire file, and will continue to work
|
|
|
|
|
with `mdbook test`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1003](https://github.com/rust-lang/mdBook/pull/1003)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Added Ctrl-Enter shortcut to the playpen editor to automatically run the
|
|
|
|
|
sample.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1066](https://github.com/rust-lang/mdBook/pull/1066)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Added `output.html.playpen.copyable` configuration option to disable
|
|
|
|
|
the copy button.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1050](https://github.com/rust-lang/mdBook/pull/1050)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Added ability to dynamically expand and fold sections within the sidebar.
|
|
|
|
|
See the `output.html.fold` configuration to enable this feature.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1027](https://github.com/rust-lang/mdBook/pull/1027)
|
2019-10-22 02:41:39 +08:00
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Use standard `scrollbar-color` CSS along with webkit extension
|
2019-10-29 21:04:16 +08:00
|
|
|
[#816](https://github.com/rust-lang/mdBook/pull/816)
|
2019-10-22 02:41:39 +08:00
|
|
|
- The renderer build directory is no longer deleted before the renderer is
|
|
|
|
|
run. This allows a backend to cache results between runs.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#985](https://github.com/rust-lang/mdBook/pull/985)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Next/prev links now highlight on hover to indicate it is clickable.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#994](https://github.com/rust-lang/mdBook/pull/994)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Increase padding of table headers.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#824](https://github.com/rust-lang/mdBook/pull/824)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Errors in `[output.html]` config are no longer ignored.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1033](https://github.com/rust-lang/mdBook/pull/1033)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Updated highlight.js for syntax highlighting updates (primarily to add
|
|
|
|
|
async/await to Rust highlighting).
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1041](https://github.com/rust-lang/mdBook/pull/1041)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Raised minimum supported rust version to 1.35.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1003](https://github.com/rust-lang/mdBook/pull/1003)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Hidden code lines are no longer dynamically removed via JavaScript, but
|
|
|
|
|
instead managed with CSS.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#846](https://github.com/rust-lang/mdBook/pull/846)
|
|
|
|
|
[#1065](https://github.com/rust-lang/mdBook/pull/1065)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Changed the default font set for the ACE editor, giving preference to
|
|
|
|
|
"Source Code Pro".
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1062](https://github.com/rust-lang/mdBook/pull/1062)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Windows 32-bit releases are no longer published.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1071](https://github.com/rust-lang/mdBook/pull/1071)
|
2019-10-22 02:41:39 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed sidebar auto-scrolling.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1052](https://github.com/rust-lang/mdBook/pull/1052)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Fixed error message when running `clean` multiple times.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1055](https://github.com/rust-lang/mdBook/pull/1055)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Actually fix the "next" link on index.html. The previous fix didn't work.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1005](https://github.com/rust-lang/mdBook/pull/1005)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Stop using `inline-block` for `inline code`, fixing selection highlighting
|
|
|
|
|
and some rendering issues.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1058](https://github.com/rust-lang/mdBook/pull/1058)
|
2019-10-22 02:41:39 +08:00
|
|
|
- Fix header auto-hide on browsers with momentum scrolling that allows
|
|
|
|
|
negative `scrollTop`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#1070](https://github.com/rust-lang/mdBook/pull/1070)
|
2019-10-22 02:41:39 +08:00
|
|
|
|
2019-07-16 05:56:49 +08:00
|
|
|
## mdBook 0.3.1
|
2019-10-29 21:04:16 +08:00
|
|
|
[69a08ef...9cd47eb](https://github.com/rust-lang/mdBook/compare/69a08ef...9cd47eb)
|
2019-07-16 05:56:49 +08:00
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- 🔥 Added ability to include files using anchor points instead of line numbers.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#851](https://github.com/rust-lang/mdBook/pull/851)
|
2019-07-16 05:56:49 +08:00
|
|
|
- Added `language` configuration value to set the language of the book, which
|
|
|
|
|
will affect things like the `<html lang="en">` tag.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#941](https://github.com/rust-lang/mdBook/pull/941)
|
2019-07-16 05:56:49 +08:00
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Updated to handlebars 2.0.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#977](https://github.com/rust-lang/mdBook/pull/977)
|
2019-07-16 05:56:49 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed memory leak warning.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#967](https://github.com/rust-lang/mdBook/pull/967)
|
2019-07-16 05:56:49 +08:00
|
|
|
- Fix more print.html links.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#963](https://github.com/rust-lang/mdBook/pull/963)
|
2019-07-16 05:56:49 +08:00
|
|
|
- Fixed crash on some unicode input.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#978](https://github.com/rust-lang/mdBook/pull/978)
|
2019-07-16 05:56:49 +08:00
|
|
|
|
2019-06-19 06:24:26 +08:00
|
|
|
## mdBook 0.3.0
|
2019-10-29 21:04:16 +08:00
|
|
|
[6cbc41d...69a08ef](https://github.com/rust-lang/mdBook/compare/6cbc41d...69a08ef)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- Added ability to resize the sidebar.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#849](https://github.com/rust-lang/mdBook/pull/849)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Added `load_with_config_and_summary` function to `MDBook` to be able to
|
|
|
|
|
build a book with a custom `Summary`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#883](https://github.com/rust-lang/mdBook/pull/883)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Set `noindex` on `print.html` page to prevent robots from indexing it.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#844](https://github.com/rust-lang/mdBook/pull/844)
|
2019-06-13 00:30:58 +08:00
|
|
|
- Added support for ~~strikethrough~~ and GitHub-style tasklists.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#952](https://github.com/rust-lang/mdBook/pull/952)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Command-line help output is now colored.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#861](https://github.com/rust-lang/mdBook/pull/861)
|
2019-05-19 05:56:01 +08:00
|
|
|
- The build directory is now deleted before rendering starts, instead of after
|
|
|
|
|
if finishes.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#878](https://github.com/rust-lang/mdBook/pull/878)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Removed dependency on `same-file` crate.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#903](https://github.com/rust-lang/mdBook/pull/903)
|
2019-05-19 05:56:01 +08:00
|
|
|
- 💥 Renamed `with_preprecessor` to `with_preprocessor`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#906](https://github.com/rust-lang/mdBook/pull/906)
|
2019-06-13 00:30:58 +08:00
|
|
|
- Updated ACE editor to 1.4.4, should remove a JavaScript console warning.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#935](https://github.com/rust-lang/mdBook/pull/935)
|
2019-06-13 00:30:58 +08:00
|
|
|
- Dependencies have been updated.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#934](https://github.com/rust-lang/mdBook/pull/934)
|
|
|
|
|
[#945](https://github.com/rust-lang/mdBook/pull/945)
|
2019-06-13 00:30:58 +08:00
|
|
|
- Highlight.js has been updated. This fixes some TOML highlighting, and adds
|
|
|
|
|
Julia support.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#942](https://github.com/rust-lang/mdBook/pull/942)
|
2019-06-13 00:30:58 +08:00
|
|
|
- 🔥 Updated to pulldown-cmark 0.5. This may have significant changes to the
|
|
|
|
|
formatting of existing books, as the newer version has more accurate
|
|
|
|
|
interpretation of the CommonMark spec and a large number of bug fixes and
|
|
|
|
|
changes.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#898](https://github.com/rust-lang/mdBook/pull/898)
|
2019-06-13 00:30:58 +08:00
|
|
|
- The `diff` language should now highlight correctly.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#943](https://github.com/rust-lang/mdBook/pull/943)
|
2019-06-13 00:30:58 +08:00
|
|
|
- Make the blank region of a header not clickable.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#948](https://github.com/rust-lang/mdBook/pull/948)
|
2019-06-19 06:24:26 +08:00
|
|
|
- Rustdoc tests now use the preprocessed content instead of the raw,
|
|
|
|
|
unpreprocessed content.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#891](https://github.com/rust-lang/mdBook/pull/891)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fixed file change detection so that `mdbook serve` only reloads once when
|
|
|
|
|
multiple files are changed at once.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#870](https://github.com/rust-lang/mdBook/pull/870)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed on-hover color highlighting for links in sidebar.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#834](https://github.com/rust-lang/mdBook/pull/834)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed loss of focus when clicking the "Copy" button in code blocks.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#867](https://github.com/rust-lang/mdBook/pull/867)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed incorrectly stripping the path for `additional-js` files.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#796](https://github.com/rust-lang/mdBook/pull/796)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed color of `code spans` that are links.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#905](https://github.com/rust-lang/mdBook/pull/905)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed "next" navigation on index.html.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#916](https://github.com/rust-lang/mdBook/pull/916)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed keyboard chapter navigation for `file` urls.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#915](https://github.com/rust-lang/mdBook/pull/915)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed bad wrapping for inline code on some browsers.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#818](https://github.com/rust-lang/mdBook/pull/818)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Properly load an existing `SUMMARY.md` in `mdbook init`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#841](https://github.com/rust-lang/mdBook/pull/841)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixed some broken links in `print.html`.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#871](https://github.com/rust-lang/mdBook/pull/871)
|
2019-06-13 00:30:58 +08:00
|
|
|
- The Rust Playground link now supports the 2018 edition.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#946](https://github.com/rust-lang/mdBook/pull/946)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
## mdBook 0.2.3 (2018-01-18)
|
2019-10-29 21:04:16 +08:00
|
|
|
[2c20c99...6cbc41d](https://github.com/rust-lang/mdBook/compare/2c20c99...6cbc41d)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- Added an optional button to the top of the page which will link to a git
|
|
|
|
|
repository. Use the `git-repository-url` and `git-repository-icon` options
|
|
|
|
|
in the `[output.html]` section to enable it and set its appearance.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#802](https://github.com/rust-lang/mdBook/pull/802)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Added a `default-theme` option to the `[output.html]` section.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#804](https://github.com/rust-lang/mdBook/pull/804)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- 💥 Header ID anchors no longer add an arbitrary `a` character for headers
|
|
|
|
|
that start with a non-ascii-alphabetic character.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#788](https://github.com/rust-lang/mdBook/pull/788)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fix websocket hostname usage
|
2019-10-29 21:04:16 +08:00
|
|
|
[#865](https://github.com/rust-lang/mdBook/pull/865)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Fixing links in print.html
|
2019-10-29 21:04:16 +08:00
|
|
|
[#866](https://github.com/rust-lang/mdBook/pull/866)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
## mdBook 0.2.2 (2018-10-19)
|
2019-10-29 21:04:16 +08:00
|
|
|
[7e2e095...2c20c99](https://github.com/rust-lang/mdBook/compare/7e2e095...2c20c99)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
- 🎉 Process-based custom preprocessors. See [the
|
2019-10-29 21:04:16 +08:00
|
|
|
docs](https://rust-lang.github.io/mdBook/for_developers/preprocessors.html)
|
2019-05-19 05:56:01 +08:00
|
|
|
for more.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#792](https://github.com/rust-lang/mdBook/pull/792)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
- 🎉 Configurable preprocessors.
|
|
|
|
|
|
|
|
|
|
Added `build.use-default-preprocessors` boolean TOML key to allow disabling
|
|
|
|
|
the built-in `links` and `index` preprocessors.
|
|
|
|
|
|
|
|
|
|
Added `[preprocessor]` TOML tables to configure each preprocessor.
|
|
|
|
|
|
|
|
|
|
Specifying `[preprocessor.links]` or `[preprocessor.index]` will enable the
|
|
|
|
|
respective built-in preprocessor if `build.use-default-preprocessors` is
|
|
|
|
|
`false`.
|
|
|
|
|
|
|
|
|
|
Added `fn supports_renderer(&self, renderer: &str) -> bool` to the
|
|
|
|
|
`Preprocessor` trait to specify if the preprocessor supports the given
|
|
|
|
|
renderer. The default implementation always returns `true`.
|
|
|
|
|
|
|
|
|
|
`Preprocessor::run` now takes a book by value instead of a mutable
|
|
|
|
|
reference. It should return a `Book` value with the intended modifications.
|
|
|
|
|
|
|
|
|
|
Added `PreprocessorContext::renderer` to indicate the renderer being used.
|
|
|
|
|
|
2019-10-29 21:04:16 +08:00
|
|
|
[#658](https://github.com/rust-lang/mdBook/pull/658)
|
|
|
|
|
[#787](https://github.com/rust-lang/mdBook/pull/787)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fix paths to additional CSS and JavaScript files
|
2019-10-29 21:04:16 +08:00
|
|
|
[#777](https://github.com/rust-lang/mdBook/pull/777)
|
2019-05-19 05:56:01 +08:00
|
|
|
- Ensure section numbers are correctly incremented after a horizontal
|
|
|
|
|
separator
|
2019-10-29 21:04:16 +08:00
|
|
|
[#790](https://github.com/rust-lang/mdBook/pull/790)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
## mdBook 0.2.1 (2018-08-22)
|
2019-10-29 21:04:16 +08:00
|
|
|
[91ffca1...7e2e095](https://github.com/rust-lang/mdBook/compare/91ffca1...7e2e095)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- Update to handlebars-rs 1.0
|
2019-10-29 21:04:16 +08:00
|
|
|
[#761](https://github.com/rust-lang/mdBook/pull/761)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Fix table colors, broken by Stylus -> CSS transition
|
2019-10-29 21:04:16 +08:00
|
|
|
[#765](https://github.com/rust-lang/mdBook/pull/765)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
## mdBook 0.2.0 (2018-08-02)
|
|
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
- 💥 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, and use the `.md` extension. This has [several
|
2019-10-29 21:04:16 +08:00
|
|
|
advantages](https://github.com/rust-lang/mdBook/pull/603#issue-166701447),
|
2019-05-19 05:56:01 +08:00
|
|
|
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:
|
|
|
|
|
```markdown
|
|
|
|
|
[section_2](chapter_1/section_2.html)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Now it must be changed to this:
|
|
|
|
|
```markdown
|
|
|
|
|
[section_2](section_2.md)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- 💥 `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.
|
|
|
|
|
|
|
|
|
|
- Embedded rust playpens now use the "stable" playground API.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#754](https://github.com/rust-lang/mdBook/pull/754)
|
2019-05-19 05:56:01 +08:00
|
|
|
|
|
|
|
|
### Fixed
|
|
|
|
|
- Escaped includes (`\{{#include file.rs}}`) will now render correctly.
|
2019-10-29 21:04:16 +08:00
|
|
|
[f30ce01](https://github.com/rust-lang/mdBook/commit/f30ce0184d71e342141145472bf816419d30a2c5)
|
2019-05-19 05:56:01 +08:00
|
|
|
- `index.html` will now render correctly when the book's first section is
|
|
|
|
|
inside a subdirectory.
|
2019-10-29 21:04:16 +08:00
|
|
|
[#756](https://github.com/rust-lang/mdBook/pull/756)
|
