mdbook

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-054 for a complete list of changes.

v0.5.3...v0.5.4

Added

• Added zoomable images feature. #3127

Changed

• Updated dependencies. #3149 #3152 #3129 #3130

Fixed

• Fixed layout bug with images in links. #3142
• Fixed previous-chapter nav hover overlapping sidebar resize handle. #3134
• Fixed missing LICENSE files in published crates. #3135
• Switched recommendation to linkcheck2 fork. #3132
• Fixed version in CI source install docs. #3154

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-053 for a complete list of changes.

v0.5.2...v0.5.3

Changed

• Improve spacing in sidebar section headings. #3122
• Updated cargo dependencies. #3083 #3077 #3058 #3057 #3042 #3045 #3044 #3036 #3022 #3017 #3018 #3019 #2998 #2996

Fixed

• The "current" page highlighting in the sidebar now handles servers that redirect and strip the .html extension. #3028
• Remove ?highlight= from URL when highlights are dismissed via clicking. #3084
• Fix global keypresses triggering when other elements are in focus. #3087
• Fix download URL format for mdBook in CI guide. #3073
• Improve error message for invalid Font Awesome icons. #3037
• Fix nested admonitions that use wrong header colors. #3035

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-052 for a complete list of changes.

v0.5.1...v0.5.2

Changed

• Updated Rust crate html5ever to 0.36.0. #2970
• Updated cargo dependencies. #2969

Fixed

• Fixed repeated error message when HTML config is invalid in mdbook serve. #2983
• Fixed sidebar scroll position when heading nav is involved. #2982
• Fixed color for rustdoc error messages. #2981
• Fixed usage of custom preprocessors with MDBook::test. #2980

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-051 for a complete list of changes.

v0.5.0...v0.5.1

Changed

• Changed the scrollbar background to be transparent. #2932
• Ignore invalid top-level environment variable config keys. This allows setting things like MDBOOK_VERSION to not cause an error. #2952

Fixed

• Fixed the sidebar heading nav to have the correct nesting levels. #2953
• Various Font Awesome fixes and improvements. #2951

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 in the CHANGELOG.

We have prepared a 0.5 Migration Guide to help existing authors switch from 0.4.

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 to help existing authors switch from 0.4.

The final 0.5.0 release only contains the following changes since 0.5.0-beta.2:

• Added error handling to environment config handling. This checks that environment variables starting with MDBOOK_ are correctly specified instead of silently ignoring. This also fixed being able to replace entire top-level tables like MDBOOK_OUTPUT. #2942

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-050-beta2 for a complete list of changes.

v0.5.0-beta.1...v0.5.0-beta.2

Added

• Added a warning when a Font Awesome icon is missing. #2915
• Added some trace logging for event processing. #2911
• Added Config::contains_key. #2910

Changed

• Heading IDs are now lowercase. #2922
• Updated cargo dependencies. #2916
• Removed italics for in quotes/comments in code blocks with the ayu theme. #2904
• Exposed "search" feature from mdbook-driver. #2907

Fixed

• Fixed rust fenced code blocks with an indent. #2905
• Headers and dt tags are no longer modified if the tag is manually written HTML. #2913
• Fixed print page links for internal links to non-chapters. #2914
• Better handling for unbalanced HTML tags. #2924
• Handle unclosed HTML tags inside a markdown element. #2927
• Fixed missing font-awesome icons in the guide. #2926
• Hide the sidebar resize indicator when JS isn't available. #2923

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-050-beta1 for a complete list of changes.

v0.5.0-alpha.1...v0.5.0-beta.1

Changed

• Reworked the look of the header navigation. #2898
• Update cargo dependencies. #2896
• Improved the heading nav debug. #2892

Fixed

• Fixed error message for config.get deserialization error. #2902
• Filter <mark> tags from sidebar heading nav. #2899
• Avoid divide-by-zero in heading nav computation #2891
• Fixed heading nav with folded chapters. #2893

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-050-alpha1 for a complete list of changes.

v0.4.52...v0.5.0-alpha.1

Added

• The location of the generated HTML book is now displayed on the console. #2729
• ❗ Added the optional field for preprocessors. The default is false, so this also changes it so that it is an error if the preprocessor is missing. #2797
• ❗ Added MarkdownOptions struct to specify settings for markdown rendering. #2809
• Added sidebar heading navigation. This includes the output.html.sidebar-header-nav option to disable it. #2822
• Added the mdbook version to the guide. #2826
• Added Book::chapters and Book::for_each_chapter_mut to more conveniently iterate over chapters (instead of all items). #2838
• ❗ Added support for definition lists. These are enabled by default, with the option output.html.definition-lists to disable it. #2847
• ❗ Added support for admonitions. These are enabled by default, with the option output.html.admonitions to disable it. #2851

Changed

• ❗ The mdbook crate has been split into multiple crates. #2766
• The minimum Rust version has been updated to 1.88. #2844
• ❗ pulldown-cmark has been upgraded to 0.13.0, bringing a large number of fixes to markdown processing. #2401
• ❗ Switched public types to non_exhaustive to help allow them to change in a backwards-compatible way. #2779 #2823
• ❗ Unknown fields in config are now an error. #2787 #2801
• ❗ Changed id_from_content to be private. #2791
• ❗ Changed preprocessor command to use paths relative to the book root. #2796
• ❗ Replaced the {{#previous}} and {{#next}} handlebars navigation helpers with objects. #2794
• ❗ Use embedded SVG instead of fonts for icons, font-awesome 6.2. #1330
• The book.src field is no longer serialized if it is the default of "src". #2800
• ❗ Changed MDBook with_renderer/with_preprocessor to overwrite the entry if an extension of the same name is already loaded. #2802
• ❗ Changed CLI --dest-dir to be relative to the current directory, not the book root. #2806
• ❗ Changed all internal HTML IDs to have an mdbook- prefix. This helps avoid namespace conflicts with header IDs. #2808
• ❗ output.html.smart-punctuation is now true by default. #2810
• ❗ Renamed Book::sections to Book::items. #2813
• ❗ output.html.hash-files is now true by default. #2820
• Switched from log to tracing. #2829
• ❗ Rewrote the HTML rendering pipeline. #2844
• ❗ Links on the print page now link to elements on the print page instead of linking out to the individual chapters. #2844
• ❗ Moved theme copy to the Theme type and reduced visibility. #2857
• ❗ Cleaned up some fs-related utilities. #2856
• ❗ Moved get_404_output_file to HtmlConfig. #2855
• ❗ Moved take_lines functions to mdbook-driver and made private. #2854
• Updated dependencies. #2793 #2869

Removed

• ❗ Removed toml as a public dependency. #2773
• ❗ Removed the book.multilingual field. This was never used. #2775
• ❗ Removed support for google-analytics. #2776
• ❗ Removed the very old legacy config support. #2783
• ❗ Removed curly-quotes, use output.html.smart-punctuation instead. #2788
• Removed old warning about book.json. #2789
• ❗ Removed output.html.copy-fonts. The default fonts are now always copied unless you override the theme/fonts/fonts.css file. #2790
• ❗ Removed legacy relative renderer command paths. Relative renderer command paths now must always be relative to the book root. #2792
• ❗ Removed the {{theme_option}} handlebars helper. It has not been used for a while. #2795
• ❗ Removed the --dest-dir option to mdbook test. #2805

Fixed

• Fixed handling of multiple footnotes in a row. #2807
• Fixed ID collisions when the numeric suffix gets used. #2846
• Fixed missing css vars for no-js dark mode. #2850

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-0452 for a complete list of changes.

v0.4.51...v0.4.52

Note: If you have a custom index.hbs theme file, it is recommended that you update it to the latest version to pick up the fixes in this release.

Added

• Added the ability to redirect # HTML fragments using the existing output.html.redirect table. #2747
• Added the rel="edit" attribute to the edit page button. #2702

Changed

• The search index is now only loaded when the search input is opened instead of always being loaded. #2553 #2735
• The mdbook serve command has switched its underlying server library from warp to axum. #2748
• Updated dependencies. #2752

Fixed

• The sidebar is now set to display:none when it is hidden in order to prevent the browser's search from thinking the sidebar's text is visible. #2725
• Fixed search index URL not updating correctly when hash-files is enabled. #2742 #2746
• Fixed several sidebar animation bugs, particularly when manually resizing. #2750

See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-0451 for a complete list of changes.

v0.4.50...v0.4.51

Fixed

• Fixed regression that broke the S search hotkey. #2713

v0.4.49...v0.4.50

Added

• Added a keyboard shortcut help popup when pressing ?. #2608

Changed

• Changed the look of the sidebar resize handle to match the new rustdoc format. #2691
• / can now be used to open the search bar. #2698
• Pressing enter from the search bar will navigate to the first entry. #2698
• Updated opener to drop some dependencies. #2709
• Updated dependencies, MSRV raised to 1.82. #2711

Fixed

• Fixed uncaught exception when pressing down when there are no search results. #2698
• Fixed syntax highlighting of Rust code in the ACE editor. #2710

v0.4.48...v0.4.49

Added

• Added a warning on unused fields in the root of book.toml. #2622

Changed

• Updated dependencies. #2650 #2688
• Updated minimum Rust version to 1.81. #2688
• The unused book.multilingual field is no longer serialized, or shown in mdbook init. #2689
• Speed up search index loading by using JSON.parse instead of parsing JavaScript. #2633

Fixed

• Search highlighting will not try to highlight in SVG <text> elements because it breaks the element. #2668
• Fixed scrolling of the sidebar when a search highlight term is in the URL. #2675
• Fixed issues when multiple footnote definitions use the same ID. Now, only one definition is used, and a warning is displayed. #2681
• The sidebar is now restricted to 80% of the viewport width to make it possible to collapse it when the viewport is very narrow. #2679

v0.4.47...v0.4.48

Added

• Footnotes now have back-reference links. These links bring the reader back to the original location. As part of this change, footnotes are now only rendered at the bottom of the page. This also includes some styling updates and fixes for footnote rendering. #2626
• Added an "Auto" theme selection option which will default to the system-preferred mode. This will also automatically switch when the system changes the preferred mode. #2576

Changed

• The searchindex.json file has been removed; only the searchindex.js file will be generated. #2552
• Updated Javascript code to use eslint. #2554
• An error is generated if there are duplicate files in SUMMARY.md. #2613

v0.4.46...v0.4.47

Fixed

• Fixed search not showing up in sub-directories. #2586

v0.4.45...v0.4.46

Changed

• The output.html.hash-files config option has been added to add hashes to static filenames to bust any caches when a book is updated. {{resource}} template tags have been added so that links can be properly generated to those files. #1368

Fixed

• Playground links for Rust 2024 now set the edition correctly. #2557

v0.4.44...v0.4.45

Changed

• Added context to error message when rustdoc is not found. #2545
• Slightly changed the styling rules around margins of footnotes. #2524

Fixed

• Fixed an issue where it would panic if a source_path is not set. #2550

v0.4.43...v0.4.44

Added

• Added pre-built aarch64-apple-darwin binaries to the releases. #2500
• mdbook clean now shows a summary of what it did. #2458
• Added the output.html.search.chapter config setting to disable search indexing of individual chapters. #2533

Fixed

• Fixed auto-scrolling the side-bar when loading a page with a # fragment URL. #2517
• Fixed display of sidebar when javascript is disabled. #2529
• Fixed the sidebar visibility getting out of sync with the button. #2532

Changed

• ❗ Rust code block hidden lines now follow the same logic as rustdoc. This requires a space after the # symbol. #2530
• ❗ Updated the Linux pre-built binaries which requires a newer version of glibc (2.34). #2523
• Updated dependencies #2538 #2539

v0.4.42...v0.4.43

Fixed

• Fixed setting the title in mdbook init when no git user is configured. #2486

Changed

• The Rust 2024 edition no longer needs -Zunstable-options. #2495

v0.4.41...v0.4.42

Fixed

• Fixed chapter list folding. #2473

v0.4.40...v0.4.41

Note: If you have a custom index.hbs theme file, you will need to update it to the latest version.

Added

• Added preliminary support for Rust 2024 edition. #2398
• Added a full example of the remove-emphasis preprocessor. #2464

Changed

• Adjusted styling of clipboard/play icons. #2421
• Updated to handlebars v6. #2416
• Attr and section rules now have specific code highlighting. #2448
• The sidebar is now loaded from a common file, significantly reducing the book size when there are many chapters. #2414
• Updated dependencies. #2470

Fixed

• Improved theme support when JavaScript is disabled. #2454
• Fixed broken themes when localStorage has an invalid theme id. #2463
• Adjusted the line-height of superscripts (and footnotes) to avoid adding extra space between lines. #2465

v0.4.39...v0.4.40

Fixed

• Reverted the update to pulldown-cmark which broke the semver API. #2388

v0.4.38...v0.4.39

Fixed

• Fixed the automatic deploy broken in the previous release. #2383

v0.4.37...v0.4.38

Added

• Added nix to the default set of languages supported for syntax highlighting. #2262

Changed

• The output.html.curly-quotes option has been renamed to output.html.smart-punctuation to better reflect what it does. The old option curly-quotes is kept for compatibility, but may be removed in the future. #2327
• The file-watcher used in mdbook serve and mdbook watch now uses a poll-based watcher instead of the native operating system notifications. This should fix issues on various systems and environments, and more accurately detect when files change. The native watcher can still be used with the --watcher native CLI option. #2325
• mdbook test output now includes color, and shows relative paths to the source. #2259
• Updated dependencies, MSRV raised to 1.74 #2350 #2351 #2378 #2381

Fixed

• Reduced memory allocation when copying files. #2355
• Fixed the horizontal divider in SUMMARY.md from being indented into the previous nested section. #2364
• Removed unnecessary @import in the CSS. #2260

v0.4.36...v0.4.37

Changed

• ❗️ Updated the markdown parser. This brings in many changes to more closely follow the CommonMark spec. This may cause some small rendering changes. It is recommended to compare the output of the old and new version to check for changes. See https://github.com/raphlinus/pulldown-cmark/releases/tag/v0.10.0 for more information. #2308
• The warning about the legacy src/theme directory has been removed. #2263
• Updated dependencies. MSRV raised to 1.71.0. #2283 #2293 #2297 #2310 #2309
• Some internal performance/memory improvements. #2273 #2290
• Made the pathdiff dependency optional based on the watch feature. #2291

Fixed

• The s shortcut key handler should not trigger when focus is in an HTML form. #2311

v0.4.35...v0.4.36

Added

• Added Nim to the default highlighted languages. #2232
• Added a small indicator for the sidebar resize handle. #2209

Changed

• Updated dependencies. MSRV raised to 1.70.0. #2173 #2250 #2252

Fixed

• Fixed blank column in print page when the sidebar was visible. #2235
• Fixed indentation of code blocks when Javascript is disabled. #2162
• Fixed a panic when mdbook serve or mdbook watch were given certain kinds of paths. #2229

v0.4.34...v0.4.35

Added

• Added the book.text-direction setting for explicit support for right-to-left languages. #1641
• Added rel=prefetch to the "next" links to potentially improve browser performance. #2168
• Added a .warning CSS class which is styled for displaying warning blocks. #2187

Changed

• Better support of the sidebar when JavaScript is disabled. #2175

v0.4.33...v0.4.34

Fixed

• Fixed file change watcher failing on macOS with a large number of files. #2157

v0.4.32...v0.4.33

Added

• The color-scheme CSS property is now set based on the light/dark theme, which applies some slight color differences in browser elements like scroll bars on some browsers. #2134

Fixed

• Fixed watching of extra-watch-dirs when not running in the book root directory. #2146
• Reverted the dependency update to the toml crate (again!). This was an unintentional breaking change in 0.4.32. #2021
• Changed macOS change notifications to use the kqueue implementation which should fix some issues with repeated rebuilds when a file changed. #2152
• Don't set a background color in the print page for code blocks in a header. #2150

v0.4.31...v0.4.32

Fixed

• Fixed theme-color meta tag not syncing with the theme. #2118

Changed

• Updated all dependencies. #2121 #2122 #2123 #2124 #2125 #2126

v0.4.30...v0.4.31

Fixed

• Fixed menu border render flash during page navigation. #2101
• Fixed flicker setting sidebar scroll position. #2104
• Fixed compile error with proc-macro2 on latest Rust nightly. #2109

v0.4.29...v0.4.30

Added

• Added support for heading attributes. Attributes are specified in curly braces just after the heading text. An HTML ID can be specified with # and classes with .. For example: ## My heading {#custom-id .class1 .class2} #2013
• Added support for hidden code lines for languages other than Rust. The output.html.code.hidelines table allows you to define the prefix character that will be used to hide code lines based on the language. #2093

Fixed

• Fixed a few minor markdown rendering issues. #2092

v0.4.28...v0.4.29

Changed

• Built-in fonts are no longer copied when fonts/fonts.css is overridden in the theme directory. Additionally, the warning about copy-fonts has been removed if fonts/fonts.css is specified. #2080
• mdbook init --force now skips all interactive prompts as intended. #2057
• Updated dependencies #2063 #2086 #2082 #2084 #2085

Fixed

• Switched from the gitignore library to ignore. This should bring some improvements with gitignore handling. #2076

v0.4.27...v0.4.28

Changed

• The sidebar is now shown on wide screens when localstorage is disabled. #2017
• Preprocessors are now run with mdbook test. #1986

Fixed

• Fixed regression in 0.4.26 that prevented the title bar from scrolling properly on smaller screens. #2039

v0.4.26...v0.4.27

Changed

• Reverted the dependency update to the toml crate. This was an unintentional breaking change in 0.4.26. #2021

v0.4.25...v0.4.26

The 0.4.26 release has been yanked due to an unintentional breaking change.

Changed

• Removed custom scrollbars for webkit browsers #1961
• Updated some dependencies #1998 #2009 #2011
• Fonts are now part of the theme. The output.html.copy-fonts option has been deprecated. To define custom fonts, be sure to define theme/fonts.css. #1987

Fixed

• Fixed overflow viewport issue with mobile Safari #1994

e14d381...1ba74a3

Fixed

• Fixed a regression where mdbook test -L deps path-to-book would not work. #1959

eb77083...8767ebf

Fixed

• The precompiled linux-gnu mdbook binary available on GitHub Releases inadvertently switched to a newer version of glibc. This release goes back to an older version that should be more compatible on older versions of Linux. #1955

678b469...68a75da

Changed

• Updated all dependencies #1951 #1952 #1844
• Updated minimum Rust version to 1.60. #1951

Fixed

• Fixed a regression where playground code was missing hidden lines, preventing it from compiling correctly. #1950

40c06f5...4844f72

Added

• Added a --chapter option to mdbook test to specify a specific chapter to test. #1741
• Added CSS styling for <kbd> tags. #1906
• Added pre-compiled binaries for x86_64-unknown-linux-musl and aarch64-unknown-linux-musl (see Releases). #1862
• Added build.extra-watch-dirs which is an array of additional directories to watch for changes when running mdbook serve. #1884

Changed

• Removed the type="text/javascript" attribute from <script> tags. #1881
• Switched to building with Rust Edition 2021. This raises the minimum supported Rust version to 1.56. #1887
• When hidden code is hidden, the hidden parts are no longer copied to the clipboard via the copy button. #1911
• Various HTML changes and fixes to be more compliant with HTML5. #1924
• The theme picker now shows which theme is currently selected. #1935

Fixed

• Avoid blank line at the end of an ACE code block #1836

92afe9b...8f01d02

Fixed

• Fixed an issue where mdBook would fail to compile with Rust nightly-2022-07-22. #1861

53055e0...da166e0

Fixed

• Fixed a regression in 0.4.19 where inline code would have excessive padding in some situations such as headings. #1855

ae275ad...53055e0

Added

• The serve command now supports HEAD requests. #1825

Changed

• An error is now generated when a custom theme directory does not exist. #1791
• Very wide tables now have independent horizontal scrolling so that scrolling to see the rest of the table will not scroll the entire page. #1617
• The buttons on code blocks are now only shown when the mouse cursor hovers over them (or tapped on mobile). There is also some extra spacing to reduce the overlap with the code. #1806
• The first chapter always generates an index.html file. Previously it would only generate the index file for prefix chapters. #1829

Fixed

• mdbook serve --open now properly handles the case if the first chapter is a draft. #1714 #1830
• Very long words (over 80 characters) are no longer indexed to avoid a stack overflow. #1833

981b79b...ae275ad

Fixed

• Fixed rendering of SUMMARY links that contain markdown escapes or other markdown elements. #1785

a5fddfa...981b79b

Fixed

• Fixed parsing of output.html.print configuration table. #1775

68a5c09...a5fddfa

Added

• Added output.html.print.page-break config option to control whether or not there is a page break between chapters in the print output. #1728
• Added output.html.playground.runnable config option to globally disable the run button in code blocks. #1546

Changed

• The mdbook serve live reload websocket now uses the protocol, host, and port of the current page, allowing access through a proxy. #1771
• The 404 not-found page now includes the books title in the HTML title tag. #1693
• Migrated to clap 3.0 which handles CLI option parsing. #1731

Fixed

• Minor fixes to the markdown parser. #1729
• Fixed incorrect parsing in SUMMARY.md when it didn't start with a title. #1744
• Fixed duplicate anchor IDs for links in search results. #1749

5eb7d46...68a5c09

Changed

• Major update to expand the documentation located at https://rust-lang.github.io/mdBook/. #1709 #1710
• Updated the markdown parser with various fixes for common-mark compliance. #1712

ffa8284...c9b6be8

Added

• The 2021 Rust edition option has been stabilized. #1642

Changed

• Header anchors no longer include any HTML tags. Previously only a small subset were excluded. #1683
• Deprecated the google-analytics option. Books using this option should place the appropriate code in the theme/head.hbs file instead. #1675

Fixed

• Updated the markdown parser which brings in a few small fixes and removes the custom smart quote handling. #1668
• Fixed iOS Safari enlarging text when going into landscape mode. #1685

e6629cd...f55028b

Added

• Added the ability to specify the preprocessor order. #1607

Fixed

• Include chapters with no headers in the search index #1637
• Switched to the opener crate for opening a web browser, which should fix some issues with blocking. #1656
• Fixed clicking the border of the theme switcher breaking the theme selection. #1651

14add9c...8b4e488

Changed

• Reverted the change to update to highlight.js 11, as it broke hidden code lines. #1597

e440094...2cf00d0

Added

• Added support for Rust 2021 edition. #1596
• Added mdbook completions subcommand which provides shell completions. #1425
• Added --title and --ignore flags to mdbook init to avoid the interactive input. #1559

Changed

• If running a Rust example does not have any output, it now displays the text "No output" instead of not showing anything. #1599
• Code block language tags can now be separated by space or tab (along with commas) to match the behavior of other sites like GitHub and rustdoc. #1469
• Updated warp (the web server) to the latest version. This also updates the minimum supported Rust version to 1.46. #1612
• Updated to highlight.js 11. This has various highlighting improvements. #1597

Fixed

• Inline code blocks inside a header are no longer highlighted when output.html.playground.editable is true. #1613

2f7293a...dc2062a

Changed

• Reverted breaking change in 0.4.9 that removed the __non_exhaustive marker on the Book struct. #1572
• Updated handlebars to 4.0. #1550
• Removed the chapter_begin id on the print page's chapter separators. #1541

7e01cf9...d325c60

Changed

• Updated all dependencies and raised the minimum Rust version to 1.42. #1528
• Added more detail to error message when a preprocessor fails. #1526
• Set max-width of HTML video tags to 100% to match img tags. #1542

Fixed

• Type errors when parsing book.toml are no longer ignored. #1539
• Better handling if mdbook serve fails to start the http server. #1555
• Fixed the path for edit-url-template if the book used a source directory other than src. #1554

fcceee4...b592b10

Added

• Added the option output.html.edit-url-template which can be a URL which is linked on each page to direct the user to a site (such as GitHub) where the user can directly suggest an edit for the page they are currently reading. #1506

Changed

• Printed output now includes a page break between chapters. #1485

Fixed

• HTML, such as HTML comments, is now ignored if it appears above the title line in SUMMARY.md. #1437

9a9eb01...c83bbd6

Changed

• Updated shlex parser to fix a minor parsing issue (used by the preprocessor/backend custom command config). #1471
• Enhanced text contrast of light theme to improve accessibility. #1470

Fixed

• Fixed some issues with fragment scrolling and linking. #1463

eaa6914...1a0c296

Changed

• The chapter name is now included in the search breadcrumbs. #1389
• Pressing Escape will remove the ?highlight argument from the URL. #1427
• mdbook init --theme will now place the theme in the root of the book directory instead of in the src directory. #1432
• A custom renderer that sets the command to a relative path now interprets the relative path relative to the book root. Previously it was inconsistent based on the platform (either relative to the current directory, or relative to the renderer output directory). Paths relative to the output directory are still supported with a deprecation warning. #1418
• The theme directory in the config is now interpreted as relative to the book root, instead of the current directory. #1405
• Handle UTF-8 BOM for chapter sources. #1285
• Removed extra whitespace added to {{#playground}} snippets. #1375

Fixed

• Clicking on a search result with multiple search words will now correctly highlight all of the words. #1426
• Properly handle < and > characters in the table of contents. #1376
• Fixed to properly serialize the build table in the config, which prevented setting it in the API. #1378

eaa6914...f66df09

Fixed

• Fixed XSS in the search page. CVE-2020-26297 648c9ae

4df9ec9...01836ba

Added

• Added the output.html.print.enable configuration value to disable the "print" page. #1169
• Added a list of supported languages for syntax-highlighting to the documentation. #1345

Fixed

• Now supports symbolic links for files in the src directory. #1323

9278b83...4df9ec9

Added

• Added output.html.cname option to emit a CNAME file which is used by GitHub Pages to know which domain is being used. #1311

Changed

• mdbook test no longer stops on the first test failure, but instead will run all the tests. #1313
• Removed the local font source for Source Code Pro, as the locally installed font may not render properly on FireFox on macOS. #1307

Fixed

• Added newline to end of .nojekyll file. #1310
• Fixed missing space before draft chapter titles. #1309

649f355...9278b83

Changed

• The "show hidden lines" icon has changed from the "expand" icon to an "eye". #1281
• Updated highlight.js. This adds several languages: c, c-like (effectively cpp), csharp (replaces cs), kotlin, less, lua, php-template, plaintext, python-repl, r, scss, typescript. #1277

Fixed

• Fixed SUMMARY links that contained newlines. #1291
• Fixed SUMMARY links that contain %20 spaces. #1293
• Fixed favicon so that if only the png or svg is overridden, the other is not automatically included in the <link> tag. #1272

d4df7e7...649f355

Changed

• Removed several outdated dev-dependencies. #1267

Fixed

• Fixed sidebar scrolling if the book includes part titles. #1265
• Don't include the default favicon if only one of the PNG or SVG is overridden. #1266