13 KiB

Raw Blame History

Added a markdown renderer, which is off by default. This may be useful for debugging preprocessors. #1018
Code samples may now include line numbers with the output.html.playpen.line-numbers configuration value. #1035
The watch and serve commands will now ignore files listed in .gitignore. #1044
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. #1037
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. #1003
Added Ctrl-Enter shortcut to the playpen editor to automatically run the sample. #1066
Added output.html.playpen.copyable configuration option to disable the copy button. #1050
Added ability to dynamically expand and fold sections within the sidebar. See the output.html.fold configuration to enable this feature. #1027

Changed

Use standard scrollbar-color CSS along with webkit extension #816
The renderer build directory is no longer deleted before the renderer is run. This allows a backend to cache results between runs. #985
Next/prev links now highlight on hover to indicate it is clickable. #994
Increase padding of table headers. #824
Errors in [output.html] config are no longer ignored. #1033
Updated highlight.js for syntax highlighting updates (primarily to add async/await to Rust highlighting). #1041
Raised minimum supported rust version to 1.35. #1003
Hidden code lines are no longer dynamically removed via JavaScript, but instead managed with CSS. #846 #1065
Changed the default font set for the ACE editor, giving preference to "Source Code Pro". #1062
Windows 32-bit releases are no longer published. #1071

Fixed

Fixed sidebar auto-scrolling. #1052
Fixed error message when running clean multiple times. #1055
Actually fix the "next" link on index.html. The previous fix didn't work. #1005
Stop using inline-block for inline code, fixing selection highlighting and some rendering issues. #1058
Fix header auto-hide on browsers with momentum scrolling that allows negative scrollTop. #1070

mdBook 0.3.1

69a08ef...9cd47eb

Added

🔥 Added ability to include files using anchor points instead of line numbers. #851
Added language configuration value to set the language of the book, which will affect things like the <html lang="en"> tag. #941

Changed

Updated to handlebars 2.0. #977

Fixed

Fixed memory leak warning. #967
Fix more print.html links. #963
Fixed crash on some unicode input. #978

mdBook 0.3.0

6cbc41d...69a08ef

Added

Added ability to resize the sidebar. #849
Added load_with_config_and_summary function to MDBook to be able to build a book with a custom Summary. #883
Set noindex on print.html page to prevent robots from indexing it. #844
Added support for ~~strikethrough~~ and GitHub-style tasklists. #952

Changed

Command-line help output is now colored. #861
The build directory is now deleted before rendering starts, instead of after if finishes. #878
Removed dependency on same-file crate. #903
💥 Renamed with_preprecessor to with_preprocessor. #906
Updated ACE editor to 1.4.4, should remove a JavaScript console warning. #935
Dependencies have been updated. #934 #945
Highlight.js has been updated. This fixes some TOML highlighting, and adds Julia support. #942
🔥 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. #898
The diff language should now highlight correctly. #943
Make the blank region of a header not clickable. #948
Rustdoc tests now use the preprocessed content instead of the raw, unpreprocessed content. #891

Fixed

Fixed file change detection so that mdbook serve only reloads once when multiple files are changed at once. #870
Fixed on-hover color highlighting for links in sidebar. #834
Fixed loss of focus when clicking the "Copy" button in code blocks. #867
Fixed incorrectly stripping the path for additional-js files. #796
Fixed color of code spans that are links. #905
Fixed "next" navigation on index.html. #916
Fixed keyboard chapter navigation for file urls. #915
Fixed bad wrapping for inline code on some browsers. #818
Properly load an existing SUMMARY.md in mdbook init. #841
Fixed some broken links in print.html. #871
The Rust Playground link now supports the 2018 edition. #946

mdBook 0.2.3 (2018-01-18)

2c20c99...6cbc41d

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. #802
Added a default-theme option to the [output.html] section. #804

Changed

💥 Header ID anchors no longer add an arbitrary a character for headers that start with a non-ascii-alphabetic character. #788

Fixed

Fix websocket hostname usage #865
Fixing links in print.html #866

mdBook 0.2.2 (2018-10-19)

7e2e095...2c20c99

Added

🎉 Process-based custom preprocessors. See the docs for more. #792
🎉 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.

#658 #787

Fixed

Fix paths to additional CSS and JavaScript files #777
Ensure section numbers are correctly incremented after a horizontal separator #790

mdBook 0.2.1 (2018-08-22)

91ffca1...7e2e095

Changed

Update to handlebars-rs 1.0 #761

Fixed

Fix table colors, broken by Stylus -> CSS transition #765

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 advantages, 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:
```
[section_2](chapter_1/section_2.html)
```
Now it must be changed to this:
```
[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. #754

Fixed

Escaped includes (\{{#include file.rs}}) will now render correctly. f30ce01
index.html will now render correctly when the book's first section is inside a subdirectory. #756

13 KiB Raw Blame History

Changelog

mdBook 0.3.5

Changed

Fixed

mdBook 0.3.4

Changed

mdBook 0.3.3

Changed

Fixed

mdBook 0.3.2

Added

Changed

Fixed

mdBook 0.3.1

Added

Changed

Fixed

mdBook 0.3.0

Added

Changed

Fixed

mdBook 0.2.3 (2018-01-18)

Added

Changed

Fixed

mdBook 0.2.2 (2018-10-19)

Added

Fixed

mdBook 0.2.1 (2018-08-22)

Changed

Fixed

mdBook 0.2.0 (2018-08-02)

Changed

Fixed

13 KiB

Raw Blame History