Merge pull request #1938 from ehuss/bump-version

Update to 0.4.22
2025-12-28 15:01:45 -05:00 · 2022-11-28 10:16:18 -08:00 · 2022-11-28 09:54:39 -08:00 · 2022-11-28 09:53:47 -08:00 · 2022-11-22 13:32:12 +05:30 · 2022-11-21 15:27:39 -08:00
63 changed files with 947 additions and 460 deletions
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -9,19 +9,35 @@ jobs:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        target:
+          - aarch64-unknown-linux-musl
+          - x86_64-unknown-linux-gnu
+          - x86_64-unknown-linux-musl
+          - x86_64-apple-darwin
+          - x86_64-pc-windows-msvc
+        include:
+          - target: aarch64-unknown-linux-musl
+            os: ubuntu-latest
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+          - target: x86_64-unknown-linux-musl
+            os: ubuntu-latest
+          - target: x86_64-apple-darwin
+            os: macos-latest
+          - target: x86_64-pc-windows-msvc
+            os: windows-latest
    steps:
    - uses: actions/checkout@master
    - name: Install hub
      run: ci/install-hub.sh ${{ matrix.os }}
      shell: bash
    - name: Install Rust
-      run: ci/install-rust.sh stable
+      run: ci/install-rust.sh stable ${{ matrix.target }}
      shell: bash
    - name: Build and deploy artifacts
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: ci/make-release.sh ${{ matrix.os }}
+      run: ci/make-release.sh ${{ matrix.os }} ${{ matrix.target }}
      shell: bash
  pages:
    name: GitHub Pages
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -32,7 +32,7 @@ jobs:
          - build: msrv
            os: ubuntu-latest
            # sync MSRV with docs: guide/src/guide/installation.md
-            rust: 1.54.0
+            rust: 1.56.0
    steps:
    - uses: actions/checkout@master
    - name: Install Rust
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,87 @@
 # Changelog

+## mdBook 0.4.22
+[40c06f5...4844f72](https://github.com/rust-lang/mdBook/compare/40c06f5...4844f72)
+
+### Added
+- Added a `--chapter` option to `mdbook test` to specify a specific chapter to test.
+  [#1741](https://github.com/rust-lang/mdBook/pull/1741)
+- Added CSS styling for `<kbd>` tags.
+  [#1906](https://github.com/rust-lang/mdBook/pull/1906)
+- Added pre-compiled binaries for `x86_64-unknown-linux-musl` and `aarch64-unknown-linux-musl` (see [Releases](https://github.com/rust-lang/mdBook/releases)).
+  [#1862](https://github.com/rust-lang/mdBook/pull/1862)
+- Added `build.extra-watch-dirs` which is an array of additional directories to watch for changes when running `mdbook serve`.
+  [#1884](https://github.com/rust-lang/mdBook/pull/1884)
+
+### Changed
+- Removed the `type="text/javascript"` attribute from `<script>` tags.
+  [#1881](https://github.com/rust-lang/mdBook/pull/1881)
+- Switched to building with Rust Edition 2021.
+  This raises the minimum supported Rust version to 1.56.
+  [#1887](https://github.com/rust-lang/mdBook/pull/1887)
+- When hidden code is hidden, the hidden parts are no longer copied to the clipboard via the copy button.
+  [#1911](https://github.com/rust-lang/mdBook/pull/1911)
+- Various HTML changes and fixes to be more compliant with HTML5.
+  [#1924](https://github.com/rust-lang/mdBook/pull/1924)
+- The theme picker now shows which theme is currently selected.
+  [#1935](https://github.com/rust-lang/mdBook/pull/1935)
+
+### Fixed
+- Avoid blank line at the end of an ACE code block
+  [#1836](https://github.com/rust-lang/mdBook/pull/1836)
+
+
+## mdBook 0.4.21
+[92afe9b...8f01d02](https://github.com/rust-lang/mdBook/compare/92afe9b...8f01d02)
+
+### Fixed
+- Fixed an issue where mdBook would fail to compile with Rust nightly-2022-07-22.
+  [#1861](https://github.com/rust-lang/mdBook/pull/1861)
+
+## mdBook 0.4.20
+[53055e0...da166e0](https://github.com/rust-lang/mdBook/compare/53055e0...da166e0)
+
+### Fixed
+- Fixed a regression in 0.4.19 where inline code would have excessive padding
+  in some situations such as headings.
+  [#1855](https://github.com/rust-lang/mdBook/pull/1855)
+
+## mdBook 0.4.19
+[ae275ad...53055e0](https://github.com/rust-lang/mdBook/compare/ae275ad...53055e0)
+
+### Added
+- The `serve` command now supports HEAD requests.
+  [#1825](https://github.com/rust-lang/mdBook/pull/1825)
+
+### Changed
+- An error is now generated when a custom theme directory does not exist.
+  [#1791](https://github.com/rust-lang/mdBook/pull/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](https://github.com/rust-lang/mdBook/pull/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](https://github.com/rust-lang/mdBook/pull/1806)
+- The first chapter always generates an `index.html` file. Previously it would
+  only generate the index file for prefix chapters.
+  [#1829](https://github.com/rust-lang/mdBook/pull/1829)
+
+### Fixed
+- `mdbook serve --open` now properly handles the case if the first chapter is a draft.
+  [#1714](https://github.com/rust-lang/mdBook/pull/1714)
+  [#1830](https://github.com/rust-lang/mdBook/pull/1830)
+- Very long words (over 80 characters) are no longer indexed to avoid a stack overflow.
+  [#1833](https://github.com/rust-lang/mdBook/pull/1833)
+
+## mdBook 0.4.18
+[981b79b...ae275ad](https://github.com/rust-lang/mdBook/compare/981b79b...ae275ad)
+
+### Fixed
+- Fixed rendering of SUMMARY links that contain markdown escapes or other
+  markdown elements.
+  [#1785](https://github.com/rust-lang/mdBook/pull/1785)
+
 ## mdBook 0.4.17
 [a5fddfa...981b79b](https://github.com/rust-lang/mdBook/compare/a5fddfa...981b79b)

@@ -19,7 +101,7 @@
  [#1546](https://github.com/rust-lang/mdBook/pull/1546)

 ### Changed
- The `cargo serve` live reload websocket now uses the protocol, host, and
+- The `mdbook serve` live reload websocket now uses the protocol, host, and
  port of the current page, allowing access through a proxy.
  [#1771](https://github.com/rust-lang/mdBook/pull/1771)
 - The 404 not-found page now includes the books title in the HTML title tag.
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -116,7 +116,7 @@ If possible, do your best to avoid breaking older browser releases.
 Any change to the HTML or styling is encouraged to manually check on as many browsers and platforms that you can.
 Unfortunately at this time we don't have any automated UI or browser testing, so your assistance in testing is appreciated.

-## Updating higlight.js
+## Updating highlight.js

 The following are instructions for updating [highlight.js](https://highlightjs.org/).

--- a/Cargo.lock
+++ b/Cargo.lock
@@ -28,9 +28,9 @@ dependencies = [

 [[package]]
 name = "ansi_term"
-version = "0.11.0"
+version = "0.12.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b"
+checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2"
 dependencies = [
 "winapi 0.3.9",
 ]
@@ -228,10 +228,10 @@ dependencies = [
 ]

 [[package]]
-name = "difference"
-version = "2.0.0"
+name = "diff"
+version = "0.1.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "524cbf6897b527295dff137cec09ecf3a05f4fddffd7dfcd1585403449e74198"
+checksum = "0e25ea47919b1560c4e3b7fe0aaab9becf5b84a10325ddf7db0f0ba5e1026499"

 [[package]]
 name = "difflib"
@@ -271,24 +271,21 @@ checksum = "e78d4f1cc4ae33bbfc157ed5d5a5ef3bc29227303d595861deb238fcec4e9457"

 [[package]]
 name = "elasticlunr-rs"
-version = "2.3.13"
+version = "3.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "515a402b5acb08002194dd926065be7733003bb37ac0f030dfd39160028238e1"
+checksum = "e6dae5cac90640734ee881bc5f21b6e5123f4e5235e52428db114abffc2391d6"
 dependencies = [
- "lazy_static",
 "regex",
 "serde",
 "serde_derive",
 "serde_json",
- "strum",
- "strum_macros",
 ]

 [[package]]
 name = "env_logger"
-version = "0.7.1"
+version = "0.9.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "44533bbbb3bb3c1fa17d9f2e4e38bbbaf8396ba82193c4cb1b6445d711445d36"
+checksum = "0b2cf0344971ee6c64c31be0d530793fba457d322dfec2810c453d0ef228f9c3"
 dependencies = [
 "atty",
 "humantime",
@@ -385,25 +382,11 @@ dependencies = [
 "new_debug_unreachable",
 ]

-[[package]]
-name = "futures"
-version = "0.3.16"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1adc00f486adfc9ce99f77d717836f0c5aa84965eb0b4f051f4e83f7cab53f8b"
-dependencies = [
- "futures-channel",
- "futures-core",
- "futures-io",
- "futures-sink",
- "futures-task",
- "futures-util",
-]
-
 [[package]]
 name = "futures-channel"
-version = "0.3.16"
+version = "0.3.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "74ed2411805f6e4e3d9bc904c95d5d423b89b3b25dc0250aa74729de20629ff9"
+checksum = "c3083ce4b914124575708913bca19bfe887522d6e2e6d0952943f5eac4a74010"
 dependencies = [
 "futures-core",
 "futures-sink",
@@ -411,15 +394,9 @@ dependencies = [

 [[package]]
 name = "futures-core"
-version = "0.3.16"
+version = "0.3.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "af51b1b4a7fdff033703db39de8802c673eb91855f2e0d47dcf3bf2c0ef01f99"
-
-[[package]]
-name = "futures-io"
-version = "0.3.16"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0b0e06c393068f3a6ef246c75cdca793d6a46347e75286933e5e75fd2fd11582"
+checksum = "0c09fd04b7e4073ac7156a9539b57a484a8ea920f79c7c675d05d289ab6110d3"

 [[package]]
 name = "futures-macro"
@@ -436,9 +413,9 @@ dependencies = [

 [[package]]
 name = "futures-sink"
-version = "0.3.16"
+version = "0.3.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c0f30aaa67363d119812743aa5f33c201a7a66329f97d1a887022971feea4b53"
+checksum = "21163e139fa306126e6eedaf49ecdb4588f939600f0b1e770f4205ee4b7fa868"

 [[package]]
 name = "futures-task"
@@ -548,7 +525,7 @@ dependencies = [
 "log",
 "pest",
 "pest_derive",
- "quick-error 2.0.1",
+ "quick-error",
 "serde",
 "serde_json",
 ]
@@ -584,15 +561,6 @@ dependencies = [
 "http",
 ]

-[[package]]
-name = "heck"
-version = "0.3.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d621efb26863f0e9924c6ac577e8275e5e6b77455db64ffa6c65c904e9e132c"
-dependencies = [
- "unicode-segmentation",
-]
-
 [[package]]
 name = "hermit-abi"
 version = "0.1.19"
@@ -652,12 +620,9 @@ checksum = "6456b8a6c8f33fee7d958fcd1b60d55b11940a79e63ae87013e6d22e26034440"

 [[package]]
 name = "humantime"
-version = "1.3.0"
+version = "2.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "df004cfca50ef23c36850aaaa59ad52cc70d0e90243c3c7737a4dd32dc7a3c4f"
-dependencies = [
- "quick-error 1.2.3",
-]
+checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"

 [[package]]
 name = "hyper"
@@ -724,15 +689,6 @@ dependencies = [
 "libc",
 ]

-[[package]]
-name = "input_buffer"
-version = "0.4.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f97967975f448f1a7ddb12b0bc41069d09ed6a1c161a92687e057325db35d413"
-dependencies = [
- "bytes",
-]
-
 [[package]]
 name = "iovec"
 version = "0.1.4"
@@ -840,7 +796,7 @@ checksum = "a3e378b66a060d48947b590737b30a1be76706c8dd7b8ba0f2fe3989c68a853f"

 [[package]]
 name = "mdbook"
-version = "0.4.17"
+version = "0.4.22"
 dependencies = [
 "ammonia",
 "anyhow",
@@ -853,10 +809,10 @@ dependencies = [
 "futures-util",
 "gitignore",
 "handlebars",
- "lazy_static",
 "log",
 "memchr",
 "notify",
+ "once_cell",
 "opener",
 "predicates",
 "pretty_assertions",
@@ -865,7 +821,6 @@ dependencies = [
 "select",
 "semver",
 "serde",
- "serde_derive",
 "serde_json",
 "shlex",
 "tempfile",
@@ -1042,6 +997,12 @@ dependencies = [
 "libc",
 ]

+[[package]]
+name = "once_cell"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e82dad04139b71a90c080c8463fe0dc7902db5192d939bd0950f074d014339e1"
+
 [[package]]
 name = "opaque-debug"
 version = "0.2.3"
@@ -1245,13 +1206,13 @@ dependencies = [

 [[package]]
 name = "pretty_assertions"
-version = "0.6.1"
+version = "1.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3f81e1644e1b54f5a68959a29aa86cde704219254669da328ecfdf6a1f09d427"
+checksum = "c89f989ac94207d048d92db058e4f6ec7342b0971fc58d1271ca148b799b3563"
 dependencies = [
 "ansi_term",
 "ctor",
- "difference",
+ "diff",
 "output_vt100",
 ]

@@ -1287,12 +1248,6 @@ dependencies = [
 "unicase",
 ]

-[[package]]
-name = "quick-error"
-version = "1.2.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0"
-
 [[package]]
 name = "quick-error"
 version = "2.0.1"
@@ -1483,6 +1438,9 @@ name = "serde"
 version = "1.0.129"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d1f72836d2aa753853178eda473a3b9d8e4eefdaf20523b919677e6de489f8f1"
+dependencies = [
+ "serde_derive",
+]

 [[package]]
 name = "serde_derive"
@@ -1602,24 +1560,6 @@ version = "0.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"

-[[package]]
-name = "strum"
-version = "0.21.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "aaf86bbcfd1fa9670b7a129f64fc0c9fcbbfe4f1bc4210e9e98fe71ffc12cde2"
-
-[[package]]
-name = "strum_macros"
-version = "0.21.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d06aaeeee809dbc59eb4556183dd927df67db1540de5be8d3ec0b6636358a5ec"
-dependencies = [
- "heck",
- "proc-macro2",
- "quote",
- "syn",
-]
-
 [[package]]
 name = "syn"
 version = "1.0.75"
@@ -1671,6 +1611,26 @@ version = "0.14.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0066c8d12af8b5acd21e00547c3797fde4e8677254a7ee429176ccebbe93dd80"

+[[package]]
+name = "thiserror"
+version = "1.0.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bd829fe32373d27f76265620b5309d0340cb8550f523c1dda251d6298069069a"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "1.0.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0396bc89e626244658bef819e22d0cc459e795a5ebe878e6ec336d1674a8d79a"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "time"
 version = "0.1.43"
@@ -1698,11 +1658,10 @@ checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c"

 [[package]]
 name = "tokio"
-version = "1.10.0"
+version = "1.16.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "01cf844b23c6131f624accf65ce0e4e9956a8bb329400ea5bcc26ae3a5c20b0b"
+checksum = "0c27a64b625de6d309e8c57716ba93021dccf1b3b5c97edd6d3dd2d2135afc0a"
 dependencies = [
- "autocfg",
 "bytes",
 "libc",
 "memchr",
@@ -1715,9 +1674,9 @@ dependencies = [

 [[package]]
 name = "tokio-macros"
-version = "1.3.0"
+version = "1.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "54473be61f4ebe4efd09cec9bd5d16fa51d70ea0192213d754d2d500457db110"
+checksum = "9724f9a975fb987ef7a3cd9be0350edcbe130698af5b8f7a631e23d42d052484"
 dependencies = [
 "proc-macro2",
 "quote",
@@ -1737,9 +1696,9 @@ dependencies = [

 [[package]]
 name = "tokio-tungstenite"
-version = "0.13.0"
+version = "0.15.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e1a5f475f1b9d077ea1017ecbc60890fda8e54942d680ca0b1d2b47cfa2d861b"
+checksum = "511de3f85caf1c98983545490c3d09685fa8eb634e57eec22bb4db271f46cbd8"
 dependencies = [
 "futures-util",
 "log",
@@ -1818,19 +1777,19 @@ checksum = "59547bce71d9c38b83d9c0e92b6066c4253371f15005def0c30d9657f50c7642"

 [[package]]
 name = "tungstenite"
-version = "0.12.0"
+version = "0.14.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8ada8297e8d70872fa9a551d93250a9f407beb9f37ef86494eb20012a2ff7c24"
+checksum = "a0b2d8558abd2e276b0a8df5c05a2ec762609344191e5fd23e292c910e9165b5"
 dependencies = [
 "base64",
 "byteorder",
 "bytes",
 "http",
 "httparse",
- "input_buffer",
 "log",
 "rand 0.8.4",
 "sha-1 0.9.7",
+ "thiserror",
 "url",
 "utf-8",
 ]
@@ -1871,12 +1830,6 @@ dependencies = [
 "tinyvec",
 ]

-[[package]]
-name = "unicode-segmentation"
-version = "1.8.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8895849a949e7845e06bd6dc1aa51731a103c42707010a5b591c0038fb73385b"
-
 [[package]]
 name = "unicode-xid"
 version = "0.2.2"
@@ -1939,12 +1892,13 @@ dependencies = [

 [[package]]
 name = "warp"
-version = "0.3.1"
+version = "0.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "332d47745e9a0c38636dbd454729b147d16bd1ed08ae67b3ab281c4506771054"
+checksum = "3cef4e1e9114a4b7f1ac799f16ce71c14de5778500c5450ec6b7b920c55b587e"
 dependencies = [
 "bytes",
- "futures",
+ "futures-channel",
+ "futures-util",
 "headers",
 "http",
 "hyper",
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,13 +1,13 @@
 [package]
 name = "mdbook"
-version = "0.4.17"
+version = "0.4.22"
 authors = [
    "Mathieu David <mathieudavid@mathieudavid.org>",
    "Michael-F-Bryan <michaelfbryan@gmail.com>",
    "Matt Ickstadt <mattico8@gmail.com>"
 ]
-documentation = "http://rust-lang.github.io/mdBook/index.html"
-edition = "2018"
+documentation = "https://rust-lang.github.io/mdBook/index.html"
+edition = "2021"
 exclude = ["/guide/*"]
 keywords = ["book", "gitbook", "rustbook", "markdown"]
 license = "MPL-2.0"
@@ -20,16 +20,15 @@ anyhow = "1.0.28"
 chrono = "0.4"
 clap = { version = "3.0", features = ["cargo"] }
 clap_complete = "3.0"
-env_logger = "0.7.1"
+once_cell = "1"
+env_logger = "0.9.0"
 handlebars = "4.0"
-lazy_static = "1.0"
 log = "0.4"
 memchr = "2.0"
 opener = "0.5"
 pulldown-cmark = { version = "0.9.1", default-features = false }
 regex = "1.5.5"
-serde = "1.0"
-serde_derive = "1.0"
+serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 shlex = "1"
 tempfile = "3.0"
@@ -43,10 +42,10 @@ gitignore = { version = "1.0", optional = true }
 # Serve feature
 futures-util = { version = "0.3.4", optional = true }
 tokio = { version = "1", features = ["macros", "rt-multi-thread"], optional = true }
-warp = { version = "0.3.1", default-features = false, features = ["websocket"], optional = true }
+warp = { version = "0.3.2", default-features = false, features = ["websocket"], optional = true }

 # Search feature
-elasticlunr-rs = { version = "2.3", optional = true, default-features = false }
+elasticlunr-rs = { version = "3.0.0", optional = true }
 ammonia = { version = "3", optional = true }

 [dev-dependencies]
@@ -54,7 +53,7 @@ assert_cmd = "1"
 predicates = "2"
 select = "0.5"
 semver = "1.0"
-pretty_assertions = "0.6"
+pretty_assertions = "1.2.1"
 walkdir = "2.0"

 [features]
@@ -66,3 +65,7 @@ search = ["elasticlunr-rs", "ammonia"]
 [[bin]]
 doc = false
 name = "mdbook"
+
+[[example]]
+name = "nop-preprocessor"
+test = true
--- a/ci/install-rust.sh
+++ b/ci/install-rust.sh
@@ -13,6 +13,17 @@ TOOLCHAIN="$1"
 rustup set profile minimal
 rustup component remove --toolchain=$TOOLCHAIN rust-docs || echo "already removed"
 rustup update --no-self-update $TOOLCHAIN
+if [ -n "$2" ]
+then
+    TARGET="$2"
+    HOST=$(rustc -Vv | grep ^host: | sed -e "s/host: //g")
+    if [ "$HOST" != "$TARGET" ]
+    then
+        rustup component add llvm-tools-preview --toolchain=$TOOLCHAIN
+        rustup component add rust-std-$TARGET --toolchain=$TOOLCHAIN
+    fi
+fi
+
 rustup default $TOOLCHAIN
 rustup -V
 rustc -Vv
--- a/ci/make-release.sh
+++ b/ci/make-release.sh
@@ -11,16 +11,21 @@ fi
 TAG=${GITHUB_REF#*/tags/}

 host=$(rustc -Vv | grep ^host: | sed -e "s/host: //g")
+target=$2
+if [ "$host" != "$target" ]
+then
+  export "CARGO_TARGET_$(echo $target | tr a-z- A-Z_)_LINKER"=rust-lld
+fi
 export CARGO_PROFILE_RELEASE_LTO=true
-cargo build --bin mdbook --release
-cd target/release
+cargo build --bin mdbook --release --target $target
+cd target/$target/release
 case $1 in
  ubuntu*)
-    asset="mdbook-$TAG-$host.tar.gz"
+    asset="mdbook-$TAG-$target.tar.gz"
    tar czf ../../$asset mdbook
    ;;
  macos*)
-    asset="mdbook-$TAG-$host.tar.gz"
+    asset="mdbook-$TAG-$target.tar.gz"
    # There is a bug with BSD tar on macOS where the first 8MB of the file are
    # sometimes all NUL bytes. See https://github.com/actions/cache/issues/403
    # and https://github.com/rust-lang/cargo/issues/8603 for some more
@@ -30,7 +35,7 @@ case $1 in
    tar czf ../../$asset mdbook
    ;;
  windows*)
-    asset="mdbook-$TAG-$host.zip"
+    asset="mdbook-$TAG-$target.zip"
    7z a ../../$asset mdbook.exe
    ;;
  *)
--- a/examples/nop-preprocessor.rs
+++ b/examples/nop-preprocessor.rs
@@ -101,4 +101,58 @@ mod nop_lib {
            renderer != "not-supported"
        }
    }
+
+    #[cfg(test)]
+    mod test {
+        use super::*;
+
+        #[test]
+        fn nop_preprocessor_run() {
+            let input_json = r##"[
+                {
+                    "root": "/path/to/book",
+                    "config": {
+                        "book": {
+                            "authors": ["AUTHOR"],
+                            "language": "en",
+                            "multilingual": false,
+                            "src": "src",
+                            "title": "TITLE"
+                        },
+                        "preprocessor": {
+                            "nop": {}
+                        }
+                    },
+                    "renderer": "html",
+                    "mdbook_version": "0.4.21"
+                },
+                {
+                    "sections": [
+                        {
+                            "Chapter": {
+                                "name": "Chapter 1",
+                                "content": "# Chapter 1\n",
+                                "number": [1],
+                                "sub_items": [],
+                                "path": "chapter_1.md",
+                                "source_path": "chapter_1.md",
+                                "parent_names": []
+                            }
+                        }
+                    ],
+                    "__non_exhaustive": null
+                }
+            ]"##;
+            let input_json = input_json.as_bytes();
+
+            let (ctx, book) = mdbook::preprocess::CmdPreprocessor::parse_input(input_json).unwrap();
+            let expected_book = book.clone();
+            let result = Nop::new().run(&ctx, book);
+            assert!(result.is_ok());
+
+            // The nop-preprocessor should not have made any changes to the book content.
+            let actual_book = result.unwrap();
+            assert_eq!(actual_book, expected_book);
+        }
+    }
 }
--- a/guide/src/cli/test.md
+++ b/guide/src/cli/test.md
@@ -43,7 +43,7 @@ mdbook test path/to/book
 The `--library-path` (`-L`) option allows you to add directories to the library
 search path used by `rustdoc` when it builds and tests the examples. Multiple
 directories can be specified with multiple options (`-L foo -L bar`) or with a
-comma-delimited list (`-L foo,bar`). The path should point to the Cargo 
+comma-delimited list (`-L foo,bar`). The path should point to the Cargo
 [build cache](https://doc.rust-lang.org/cargo/guide/build-cache.html) `deps` directory that
 contains the build output of your project. For example, if your Rust project's book is in a directory
 named `my-book`, the following command would include the crate's dependencies when running `test`:
@@ -61,3 +61,8 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for the
 book. Relative paths are interpreted relative to the book's root directory. If
 not specified it will default to the value of the `build.build-dir` key in
 `book.toml`, or to `./book`.
+
+#### --chapter
+
+The `--chapter` (`-c`) option allows you to test a specific chapter of the
+book using the chapter name or the relative path to the chapter.
--- a/guide/src/continuous-integration.md
+++ b/guide/src/continuous-integration.md
@@ -21,7 +21,7 @@ A simple approach would be to use the popular `curl` CLI tool to download the ex

 ```sh
 mkdir bin
-curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.17/mdbook-v0.4.17-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
+curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.22/mdbook-v0.4.22-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
 bin/mdbook build
 ```

--- a/guide/src/format/configuration/general.md
+++ b/guide/src/format/configuration/general.md
@@ -7,7 +7,7 @@ Here is an example of what a ***book.toml*** file might look like:
 ```toml
 [book]
 title = "Example book"
-author = "John Doe"
+authors = ["John Doe"]
 description = "The example book covers examples."

 [rust]
@@ -87,6 +87,7 @@ This controls the build process of your book.
 build-dir = "book"                # the directory where the output is placed
 create-missing = true             # whether or not to create missing pages
 use-default-preprocessors = true  # use the default preprocessors
+extra-watch-dirs = []             # directories to watch for triggering builds
 ```

 - **build-dir:** The directory to put the rendered book in. By default this is
@@ -108,3 +109,6 @@ use-default-preprocessors = true  # use the default preprocessors
    default preprocessors from running.
  - Adding `[preprocessor.links]`, for example, will ensure, regardless of
    `use-default-preprocessors` that `links` it will run.
+- **extra-watch-dirs**: A list of paths to directories that will be watched in
+  the `watch` and `serve` commands. Changes to files under these directories will
+  trigger rebuilds. Useful if your book depends on files outside its `src` directory.
--- a/guide/src/format/configuration/renderers.md
+++ b/guide/src/format/configuration/renderers.md
@@ -157,7 +157,8 @@ The following configuration options are available:
  Defaults to `404.md`.
 - **site-url:** The url where the book will be hosted. This is required to ensure
  navigation links and script/css imports in the 404 file work correctly, even when accessing
-  urls in subdirectories. Defaults to `/`.
+  urls in subdirectories. Defaults to `/`. If `site-url` is set,
+  make sure to use document relative links for your assets, meaning they should not start with `/`.
 - **cname:** The DNS subdomain or apex domain at which your book will be hosted.
  This string will be written to a file named CNAME in the root of your site, as
  required by GitHub Pages (see [*Managing a custom domain for your GitHub Pages
--- a/guide/src/guide/creating.md
+++ b/guide/src/guide/creating.md
@@ -97,7 +97,7 @@ So if you have images or other static files, just include them somewhere in the

 Once you've written your book, you may want to host it somewhere for others to view.
 The first step is to build the output of the book.
-This can be done with the `mbdook build` command in the same directory where the `book.toml` file is located:
+This can be done with the `mdbook build` command in the same directory where the `book.toml` file is located:

 ```sh
 mdbook build
@@ -106,4 +106,4 @@ mdbook build
 This will generate a directory named `book` which contains the HTML content of your book.
 You can then place this directory on any web server to host it.

-For more information about publishing and deploying, check out the [Continuous Integration chapter](../continuous-integration.md) for more.
+For more information about publishing and deploying, check out the [Continuous Integration chapter](../continuous-integration.md) for more.
--- a/guide/src/guide/installation.md
+++ b/guide/src/guide/installation.md
@@ -30,6 +30,8 @@ cargo install mdbook

 This will automatically download mdBook from [crates.io], build it, and install it in Cargo's global binary directory (`~/.cargo/bin/` by default).

+To uninstall, run the command `cargo uninstall mdbook`.
+
 [Rust installation page]: https://www.rust-lang.org/tools/install
 [crates.io]: https://crates.io/

--- a/src/book/book.rs
+++ b/src/book/book.rs
@@ -7,6 +7,9 @@ use std::path::{Path, PathBuf};
 use super::summary::{parse_summary, Link, SectionNumber, Summary, SummaryItem};
 use crate::config::BuildConfig;
 use crate::errors::*;
+use crate::utils::bracket_escape;
+use log::debug;
+use serde::{Deserialize, Serialize};

 /// Load a book into memory from its `src/` directory.
 pub fn load_book<P: AsRef<Path>>(src_dir: P, cfg: &BuildConfig) -> Result<Book> {
@@ -53,7 +56,7 @@ fn create_missing(src_dir: &Path, summary: &Summary) -> Result<()> {
                    let mut f = File::create(&filename).with_context(|| {
                        format!("Unable to create missing file: {}", filename.display())
                    })?;
-                    writeln!(f, "# {}", link.name)?;
+                    writeln!(f, "# {}", bracket_escape(&link.name))?;
                }
            }

--- a/src/book/init.rs
+++ b/src/book/init.rs
@@ -6,6 +6,7 @@ use super::MDBook;
 use crate::config::Config;
 use crate::errors::*;
 use crate::theme;
+use log::{debug, error, info, trace};

 /// A helper for setting up a new book and its directory structure.
 #[derive(Debug, Clone, PartialEq)]
--- a/src/book/mod.rs
+++ b/src/book/mod.rs
@@ -14,6 +14,7 @@ pub use self::book::{load_book, Book, BookItem, BookItems, Chapter};
 pub use self::init::BookBuilder;
 pub use self::summary::{parse_summary, Link, SectionNumber, Summary, SummaryItem};

+use log::{debug, error, info, log_enabled, trace, warn};
 use std::io::Write;
 use std::path::PathBuf;
 use std::process::Command;
@@ -246,6 +247,13 @@ impl MDBook {

    /// Run `rustdoc` tests on the book, linking against the provided libraries.
    pub fn test(&mut self, library_paths: Vec<&str>) -> Result<()> {
+        // test_chapter with chapter:None will run all tests.
+        self.test_chapter(library_paths, None)
+    }
+
+    /// Run `rustdoc` tests on a specific chapter of the book, linking against the provided libraries.
+    /// If `chapter` is `None`, all tests will be run.
+    pub fn test_chapter(&mut self, library_paths: Vec<&str>, chapter: Option<&str>) -> Result<()> {
        let library_args: Vec<&str> = (0..library_paths.len())
            .map(|_| "-L")
            .zip(library_paths.into_iter())
@@ -254,6 +262,8 @@ impl MDBook {

        let temp_dir = TempFileBuilder::new().prefix("mdbook-").tempdir()?;

+        let mut chapter_found = false;
+
        // FIXME: Is "test" the proper renderer name to use here?
        let preprocess_context =
            PreprocessorContext::new(self.root.clone(), self.config.clone(), "test".to_string());
@@ -270,8 +280,16 @@ impl MDBook {
                    _ => continue,
                };

-                let path = self.source_dir().join(&chapter_path);
-                info!("Testing file: {:?}", path);
+                if let Some(chapter) = chapter {
+                    if ch.name != chapter && chapter_path.to_str() != Some(chapter) {
+                        if chapter == "?" {
+                            info!("Skipping chapter '{}'...", ch.name);
+                        }
+                        continue;
+                    }
+                }
+                chapter_found = true;
+                info!("Testing chapter '{}': {:?}", ch.name, chapter_path);

                // write preprocessed file to tempdir
                let path = temp_dir.path().join(&chapter_path);
@@ -311,6 +329,11 @@ impl MDBook {
        if failed {
            bail!("One or more tests failed");
        }
+        if let Some(chapter) = chapter {
+            if !chapter_found {
+                bail!("Chapter not found: {}", chapter);
+            }
+        }
        Ok(())
    }

@@ -386,7 +409,7 @@ fn determine_renderers(config: &Config) -> Vec<Box<dyn Renderer>> {
    renderers
 }

-const DEFAULT_PREPROCESSORS: &[&'static str] = &["links", "index"];
+const DEFAULT_PREPROCESSORS: &[&str] = &["links", "index"];

 fn is_default_preprocessor(pre: &dyn Preprocessor) -> bool {
    let name = pre.name();
@@ -756,10 +779,9 @@ mod tests {

        let preprocessors = determine_preprocessors(&cfg).unwrap();

-        assert!(preprocessors
+        assert!(!preprocessors
            .iter()
-            .find(|preprocessor| preprocessor.name() == "random")
-            .is_none());
+            .any(|preprocessor| preprocessor.name() == "random"));
    }

    #[test]
@@ -776,10 +798,9 @@ mod tests {

        let preprocessors = determine_preprocessors(&cfg).unwrap();

-        assert!(preprocessors
+        assert!(!preprocessors
            .iter()
-            .find(|preprocessor| preprocessor.name() == "links")
-            .is_none());
+            .any(|preprocessor| preprocessor.name() == "links"));
    }

    #[test]
--- a/src/book/summary.rs
+++ b/src/book/summary.rs
@@ -1,6 +1,8 @@
 use crate::errors::*;
+use log::{debug, trace, warn};
 use memchr::{self, Memchr};
 use pulldown_cmark::{self, Event, HeadingLevel, Tag};
+use serde::{Deserialize, Serialize};
 use std::fmt::{self, Display, Formatter};
 use std::iter::FromIterator;
 use std::ops::{Deref, DerefMut};
@@ -452,7 +454,7 @@ impl<'a> SummaryParser<'a> {
                    items.push(item);
                }
                Some(Event::Start(Tag::List(..))) => {
-                    // Skip this tag after comment bacause it is not nested.
+                    // Skip this tag after comment because it is not nested.
                    if items.is_empty() {
                        continue;
                    }
--- a/src/cmd/build.rs
+++ b/src/cmd/build.rs
@@ -38,7 +38,12 @@ pub fn execute(args: &ArgMatches) -> Result<()> {

    if args.is_present("open") {
        // FIXME: What's the right behaviour if we don't use the HTML renderer?
-        open(book.build_dir_for("html").join("index.html"));
+        let path = book.build_dir_for("html").join("index.html");
+        if !path.exists() {
+            error!("No chapter available to open");
+            std::process::exit(1)
+        }
+        open(path);
    }

    Ok(())
--- a/src/cmd/init.rs
+++ b/src/cmd/init.rs
@@ -122,8 +122,5 @@ fn confirm() -> bool {
    io::stdout().flush().unwrap();
    let mut s = String::new();
    io::stdin().read_line(&mut s).ok();
-    match &*s.trim() {
-        "Y" | "y" | "yes" | "Yes" => true,
-        _ => false,
-    }
+    matches!(&*s.trim(), "Y" | "y" | "yes" | "Yes")
 }
--- a/src/cmd/serve.rs
+++ b/src/cmd/serve.rs
@@ -89,8 +89,7 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
    let input_404 = book
        .config
        .get("output.html.input-404")
-        .map(toml::Value::as_str)
-        .and_then(std::convert::identity) // flatten
+        .and_then(toml::Value::as_str)
        .map(ToString::to_string);
    let file_404 = get_404_output_file(&input_404);

--- a/src/cmd/test.rs
+++ b/src/cmd/test.rs
@@ -17,6 +17,16 @@ pub fn make_subcommand<'help>() -> App<'help> {
                    Relative paths are interpreted relative to the book's root directory.{n}\
                    If omitted, mdBook uses build.build-dir from book.toml or defaults to `./book`.",
                ),
+        ).arg(
+            Arg::new("chapter")
+                .short('c')
+                .long("chapter")
+                .value_name("chapter")
+                .help(
+                    "Only test the specified chapter{n}\
+                    Where the name of the chapter is defined in the SUMMARY.md file.{n}\
+                    Use the special name \"?\" to the list of chapter names."
+                )
        )
        .arg(arg!([dir]
            "Root directory for the book{n}\
@@ -41,14 +51,18 @@ pub fn execute(args: &ArgMatches) -> Result<()> {
        .values_of("library-path")
        .map(std::iter::Iterator::collect)
        .unwrap_or_default();
+    let chapter: Option<&str> = args.value_of("chapter");
+
    let book_dir = get_book_dir(args);
    let mut book = MDBook::load(&book_dir)?;

    if let Some(dest_dir) = args.value_of("dest-dir") {
        book.config.build.build_dir = dest_dir.into();
    }
-
-    book.test(library_paths)?;
+    match chapter {
+        Some(_) => book.test_chapter(library_paths, chapter),
+        None => book.test(library_paths),
+    }?;

    Ok(())
 }
--- a/src/cmd/watch.rs
+++ b/src/cmd/watch.rs
@@ -45,7 +45,12 @@ pub fn execute(args: &ArgMatches) -> Result<()> {

    if args.is_present("open") {
        book.build()?;
-        open(book.build_dir_for("html").join("index.html"));
+        let path = book.build_dir_for("html").join("index.html");
+        if !path.exists() {
+            error!("No chapter available to open");
+            std::process::exit(1)
+        }
+        open(path);
    }

    trigger_on_change(&book, |paths, book_dir| {
@@ -141,6 +146,17 @@ where
    // Add the book.toml file to the watcher if it exists
    let _ = watcher.watch(book.root.join("book.toml"), NonRecursive);

+    for dir in &book.config.build.extra_watch_dirs {
+        let path = dir.canonicalize().unwrap();
+        if let Err(e) = watcher.watch(&path, Recursive) {
+            error!(
+                "Error while watching extra directory {:?}:\n    {:?}",
+                path, e
+            );
+            std::process::exit(1);
+        }
+    }
+
    info!("Listening for changes...");

    loop {
@@ -161,7 +177,11 @@ where
            })
            .collect::<Vec<_>>();

-        let paths = remove_ignored_files(&book.root, &paths[..]);
+        // If we are watching files outside the current repository (via extra-watch-dirs), then they are definitionally
+        // ignored by gitignore. So we handle this case by including such files into the watched paths list.
+        let any_external_paths = paths.iter().filter(|p| !p.starts_with(&book.root)).cloned();
+        let mut paths = remove_ignored_files(&book.root, &paths[..]);
+        paths.extend(any_external_paths);

        if !paths.is_empty() {
            closure(paths, &book.root);
--- a/src/config.rs
+++ b/src/config.rs
@@ -49,6 +49,7 @@

 #![deny(missing_docs)]

+use log::{debug, trace, warn};
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 use std::collections::HashMap;
 use std::env;
@@ -227,10 +228,10 @@ impl Config {
        let value = Value::try_from(value)
            .with_context(|| "Unable to represent the item as a JSON Value")?;

-        if index.starts_with("book.") {
-            self.book.update_value(&index[5..], value);
-        } else if index.starts_with("build.") {
-            self.build.update_value(&index[6..], value);
+        if let Some(key) = index.strip_prefix("book.") {
+            self.book.update_value(key, value);
+        } else if let Some(key) = index.strip_prefix("build.") {
+            self.build.update_value(key, value);
        } else {
            self.rest.insert(index, value);
        }
@@ -295,7 +296,7 @@ impl Default for Config {
    }
 }

-impl<'de> Deserialize<'de> for Config {
+impl<'de> serde::Deserialize<'de> for Config {
    fn deserialize<D: Deserializer<'de>>(de: D) -> std::result::Result<Self, D::Error> {
        let raw = Value::deserialize(de)?;

@@ -371,15 +372,8 @@ impl Serialize for Config {
 }

 fn parse_env(key: &str) -> Option<String> {
-    const PREFIX: &str = "MDBOOK_";
-
-    if key.starts_with(PREFIX) {
-        let key = &key[PREFIX.len()..];
-
-        Some(key.to_lowercase().replace("__", ".").replace("_", "-"))
-    } else {
-        None
-    }
+    key.strip_prefix("MDBOOK_")
+        .map(|key| key.to_lowercase().replace("__", ".").replace('_', "-"))
 }

 fn is_legacy_format(table: &Value) -> bool {
@@ -444,6 +438,8 @@ pub struct BuildConfig {
    /// Should the default preprocessors always be used when they are
    /// compatible with the renderer?
    pub use_default_preprocessors: bool,
+    /// Extra directories to trigger rebuild when watching/serving
+    pub extra_watch_dirs: Vec<PathBuf>,
 }

 impl Default for BuildConfig {
@@ -452,6 +448,7 @@ impl Default for BuildConfig {
            build_dir: PathBuf::from("book"),
            create_missing: true,
            use_default_preprocessors: true,
+            extra_watch_dirs: Vec::new(),
        }
    }
 }
@@ -533,10 +530,9 @@ pub struct HtmlConfig {
    /// directly jumping to editing the currently viewed page.
    /// Contains {path} that is replaced with chapter source file path
    pub edit_url_template: Option<String>,
-    /// Endpoint of websocket, for livereload usage. Value loaded from .toml file
-    /// is ignored, because our code overrides this field with the value [`LIVE_RELOAD_ENDPOINT`]
-    ///
-    /// [`LIVE_RELOAD_ENDPOINT`]: cmd::serve::LIVE_RELOAD_ENDPOINT
+    /// Endpoint of websocket, for livereload usage. Value loaded from .toml
+    /// file is ignored, because our code overrides this field with an
+    /// internal value (`LIVE_RELOAD_ENDPOINT)
    ///
    /// This config item *should not be edited* by the end user.
    #[doc(hidden)]
@@ -724,6 +720,7 @@ impl<'de, T> Updateable<'de> for T where T: Serialize + Deserialize<'de> {}
 mod tests {
    use super::*;
    use crate::utils::fs::get_404_output_file;
+    use serde_json::json;

    const COMPLEX_CONFIG: &str = r#"
        [book]
@@ -777,6 +774,7 @@ mod tests {
            build_dir: PathBuf::from("outputs"),
            create_missing: false,
            use_default_preprocessors: true,
+            extra_watch_dirs: Vec::new(),
        };
        let rust_should_be = RustConfig { edition: None };
        let playground_should_be = Playground {
@@ -828,7 +826,7 @@ mod tests {
        "#;

        let got = Config::from_str(src).unwrap();
-        assert_eq!(got.html_config().unwrap().playground.runnable, false);
+        assert!(!got.html_config().unwrap().playground.runnable);
    }

    #[test]
@@ -987,6 +985,7 @@ mod tests {
            build_dir: PathBuf::from("my-book"),
            create_missing: true,
            use_default_preprocessors: true,
+            extra_watch_dirs: Vec::new(),
        };

        let html_should_be = HtmlConfig {
@@ -1037,7 +1036,7 @@ mod tests {
    fn encode_env_var(key: &str) -> String {
        format!(
            "MDBOOK_{}",
-            key.to_uppercase().replace('.', "__").replace("-", "_")
+            key.to_uppercase().replace('.', "__").replace('-', "_")
        )
    }

@@ -1061,11 +1060,10 @@ mod tests {
    }

    #[test]
-    #[allow(clippy::approx_constant)]
    fn update_config_using_env_var_and_complex_value() {
        let mut cfg = Config::default();
        let key = "foo-bar.baz";
-        let value = json!({"array": [1, 2, 3], "number": 3.14});
+        let value = json!({"array": [1, 2, 3], "number": 13.37});
        let value_str = serde_json::to_string(&value).unwrap();

        assert!(cfg.get(key).is_none());
@@ -1184,15 +1182,15 @@ mod tests {
        "#;
        let got = Config::from_str(src).unwrap();
        let html_config = got.html_config().unwrap();
-        assert_eq!(html_config.print.enable, false);
-        assert_eq!(html_config.print.page_break, true);
+        assert!(!html_config.print.enable);
+        assert!(html_config.print.page_break);
        let src = r#"
        [output.html.print]
        page-break = false
        "#;
        let got = Config::from_str(src).unwrap();
        let html_config = got.html_config().unwrap();
-        assert_eq!(html_config.print.enable, true);
-        assert_eq!(html_config.print.page_break, false);
+        assert!(html_config.print.enable);
+        assert!(!html_config.print.page_break);
    }
 }
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -82,20 +82,6 @@

 #![deny(missing_docs)]
 #![deny(rust_2018_idioms)]
-#![allow(clippy::comparison_chain)]
-
-#[macro_use]
-extern crate lazy_static;
-#[macro_use]
-extern crate log;
-#[macro_use]
-extern crate serde_derive;
-#[macro_use]
-extern crate serde_json;
-
-#[cfg(test)]
-#[macro_use]
-extern crate pretty_assertions;

 pub mod book;
 pub mod config;
--- a/src/preprocess/cmd.rs
+++ b/src/preprocess/cmd.rs
@@ -1,6 +1,7 @@
 use super::{Preprocessor, PreprocessorContext};
 use crate::book::Book;
 use crate::errors::*;
+use log::{debug, trace, warn};
 use shlex::Shlex;
 use std::io::{self, Read, Write};
 use std::process::{Child, Command, Stdio};
--- a/src/preprocess/index.rs
+++ b/src/preprocess/index.rs
@@ -1,10 +1,11 @@
 use regex::Regex;
 use std::path::Path;

-use crate::errors::*;
-
 use super::{Preprocessor, PreprocessorContext};
 use crate::book::{Book, BookItem};
+use crate::errors::*;
+use log::warn;
+use once_cell::sync::Lazy;

 /// A preprocessor for converting file name `README.md` to `index.md` since
 /// `README.md` is the de facto index file in markdown-based documentation.
@@ -67,9 +68,8 @@ fn warn_readme_name_conflict<P: AsRef<Path>>(readme_path: P, index_path: P) {
 }

 fn is_readme_file<P: AsRef<Path>>(path: P) -> bool {
-    lazy_static! {
-        static ref RE: Regex = Regex::new(r"(?i)^readme$").unwrap();
-    }
+    static RE: Lazy<Regex> = Lazy::new(|| Regex::new(r"(?i)^readme$").unwrap());
+
    RE.is_match(
        path.as_ref()
            .file_stem()
--- a/src/preprocess/links.rs
+++ b/src/preprocess/links.rs
@@ -10,6 +10,8 @@ use std::path::{Path, PathBuf};

 use super::{Preprocessor, PreprocessorContext};
 use crate::book::{Book, BookItem};
+use log::{error, warn};
+use once_cell::sync::Lazy;

 const ESCAPE_CHAR: char = '\\';
 const MAX_LINK_NESTED_DEPTH: usize = 10;
@@ -146,6 +148,7 @@ enum RangeOrAnchor {
 }

 // A range of lines specified with some include directive.
+#[allow(clippy::enum_variant_names)] // The prefix can't be removed, and is meant to mirror the contained type
 #[derive(PartialEq, Debug, Clone)]
 enum LineRange {
    Range(Range<usize>),
@@ -407,19 +410,20 @@ impl<'a> Iterator for LinkIter<'a> {
 fn find_links(contents: &str) -> LinkIter<'_> {
    // lazily compute following regex
    // r"\\\{\{#.*\}\}|\{\{#([a-zA-Z0-9]+)\s*([^}]+)\}\}")?;
-    lazy_static! {
-        static ref RE: Regex = Regex::new(
+    static RE: Lazy<Regex> = Lazy::new(|| {
+        Regex::new(
            r"(?x)              # insignificant whitespace mode
-            \\\{\{\#.*\}\}      # match escaped link
-            |                   # or
-            \{\{\s*             # link opening parens and whitespace
-            \#([a-zA-Z0-9_]+)   # link type
-            \s+                 # separating whitespace
-            ([^}]+)             # link target path and space separated properties
-            \}\}                # link closing parens"
+        \\\{\{\#.*\}\}      # match escaped link
+        |                   # or
+        \{\{\s*             # link opening parens and whitespace
+        \#([a-zA-Z0-9_]+)   # link type
+        \s+                 # separating whitespace
+        ([^}]+)             # link target path and space separated properties
+        \}\}                # link closing parens",
        )
-        .unwrap();
-    }
+        .unwrap()
+    });
+
    LinkIter(RE.captures_iter(contents))
 }

--- a/src/preprocess/mod.rs
+++ b/src/preprocess/mod.rs
@@ -12,6 +12,7 @@ use crate::book::Book;
 use crate::config::Config;
 use crate::errors::*;

+use serde::{Deserialize, Serialize};
 use std::cell::RefCell;
 use std::collections::HashMap;
 use std::path::PathBuf;
--- a/src/renderer/html_handlebars/hbs_renderer.rs
+++ b/src/renderer/html_handlebars/hbs_renderer.rs
@@ -14,7 +14,10 @@ use std::path::{Path, PathBuf};

 use crate::utils::fs::get_404_output_file;
 use handlebars::Handlebars;
+use log::{debug, trace, warn};
+use once_cell::sync::Lazy;
 use regex::{Captures, Regex};
+use serde_json::json;

 #[derive(Default)]
 pub struct HtmlHandlebars;
@@ -116,7 +119,7 @@ impl HtmlHandlebars {
        if ctx.is_index {
            ctx.data.insert("path".to_owned(), json!("index.md"));
            ctx.data.insert("path_to_root".to_owned(), json!(""));
-            ctx.data.insert("is_index".to_owned(), json!("true"));
+            ctx.data.insert("is_index".to_owned(), json!(true));
            let rendered_index = ctx.handlebars.render("index", &ctx.data)?;
            let rendered_index =
                self.post_process(rendered_index, &ctx.html_config.playground, ctx.edition);
@@ -337,6 +340,7 @@ impl HtmlHandlebars {
        );
        handlebars.register_helper("previous", Box::new(helpers::navigation::previous));
        handlebars.register_helper("next", Box::new(helpers::navigation::next));
+        // TODO: remove theme_option in 0.5, it is not needed.
        handlebars.register_helper("theme_option", Box::new(helpers::theme::theme_option));
    }

@@ -481,7 +485,13 @@ impl Renderer for HtmlHandlebars {
        let mut handlebars = Handlebars::new();

        let theme_dir = match html_config.theme {
-            Some(ref theme) => ctx.root.join(theme),
+            Some(ref theme) => {
+                let dir = ctx.root.join(theme);
+                if !dir.is_dir() {
+                    bail!("theme dir {} does not exist", dir.display());
+                }
+                dir
+            }
            None => ctx.root.join("theme"),
        };

@@ -534,7 +544,8 @@ impl Renderer for HtmlHandlebars {
                chapter_titles: &ctx.chapter_titles,
            };
            self.render_item(item, ctx, &mut print_content)?;
-            is_index = false;
+            // Only the first non-draft chapter item should be treated as the "index"
+            is_index &= !matches!(item, BookItem::Chapter(ch) if !ch.is_draft_chapter());
        }

        // Render 404 page
@@ -620,6 +631,7 @@ fn make_data(
        );
    }

+    // TODO: remove default_theme in 0.5, it is not needed.
    let default_theme = match html_config.default_theme {
        Some(ref theme) => theme.to_lowercase(),
        None => "light".to_string(),
@@ -757,10 +769,12 @@ fn make_data(
 /// Goes through the rendered HTML, making sure all header tags have
 /// an anchor respectively so people can link to sections directly.
 fn build_header_links(html: &str) -> String {
-    let regex = Regex::new(r"<h(\d)>(.*?)</h\d>").unwrap();
+    static BUILD_HEADER_LINKS: Lazy<Regex> =
+        Lazy::new(|| Regex::new(r"<h(\d)>(.*?)</h\d>").unwrap());
+
    let mut id_counter = HashMap::new();

-    regex
+    BUILD_HEADER_LINKS
        .replace_all(html, |caps: &Captures<'_>| {
            let level = caps[1]
                .parse()
@@ -797,11 +811,13 @@ fn insert_link_into_header(
 // ```
 // This function replaces all commas by spaces in the code block classes
 fn fix_code_blocks(html: &str) -> String {
-    let regex = Regex::new(r##"<code([^>]+)class="([^"]+)"([^>]*)>"##).unwrap();
-    regex
+    static FIX_CODE_BLOCKS: Lazy<Regex> =
+        Lazy::new(|| Regex::new(r##"<code([^>]+)class="([^"]+)"([^>]*)>"##).unwrap());
+
+    FIX_CODE_BLOCKS
        .replace_all(html, |caps: &Captures<'_>| {
            let before = &caps[1];
-            let classes = &caps[2].replace(",", " ");
+            let classes = &caps[2].replace(',', " ");
            let after = &caps[3];

            format!(
@@ -819,8 +835,10 @@ fn add_playground_pre(
    playground_config: &Playground,
    edition: Option<RustEdition>,
 ) -> String {
-    let regex = Regex::new(r##"((?s)<code[^>]?class="([^"]+)".*?>(.*?)</code>)"##).unwrap();
-    regex
+    static ADD_PLAYGROUND_PRE: Lazy<Regex> =
+        Lazy::new(|| Regex::new(r##"((?s)<code[^>]?class="([^"]+)".*?>(.*?)</code>)"##).unwrap());
+
+    ADD_PLAYGROUND_PRE
        .replace_all(html, |caps: &Captures<'_>| {
            let text = &caps[1];
            let classes = &caps[2];
@@ -864,11 +882,8 @@ fn add_playground_pre(
                                // we need to inject our own main
                                let (attrs, code) = partition_source(code);

-                                format!(
-                                    "\n# #![allow(unused)]\n{}#fn main() {{\n{}#}}",
-                                    attrs, code
-                                )
-                                .into()
+                                format!("# #![allow(unused)]\n{}#fn main() {{\n{}#}}", attrs, code)
+                                    .into()
                            };
                            hide_lines(&content)
                        }
@@ -884,19 +899,20 @@ fn add_playground_pre(
        .into_owned()
 }

-lazy_static! {
-    static ref BORING_LINES_REGEX: Regex = Regex::new(r"^(\s*)#(.?)(.*)$").unwrap();
-}
-
 fn hide_lines(content: &str) -> String {
+    static BORING_LINES_REGEX: Lazy<Regex> = Lazy::new(|| Regex::new(r"^(\s*)#(.?)(.*)$").unwrap());
+
    let mut result = String::with_capacity(content.len());
-    for line in content.lines() {
+    let mut lines = content.lines().peekable();
+    while let Some(line) = lines.next() {
+        // Don't include newline on the last line.
+        let newline = if lines.peek().is_none() { "" } else { "\n" };
        if let Some(caps) = BORING_LINES_REGEX.captures(line) {
            if &caps[2] == "#" {
                result += &caps[1];
                result += &caps[2];
                result += &caps[3];
-                result += "\n";
+                result += newline;
                continue;
            } else if &caps[2] != "!" && &caps[2] != "[" {
                result += "<span class=\"boring\">";
@@ -905,13 +921,13 @@ fn hide_lines(content: &str) -> String {
                    result += &caps[2];
                }
                result += &caps[3];
-                result += "\n";
+                result += newline;
                result += "</span>";
                continue;
            }
        }
        result += line;
-        result += "\n";
+        result += newline;
    }
    result
 }
@@ -991,19 +1007,19 @@ mod tests {
    fn add_playground() {
        let inputs = [
          ("<code class=\"language-rust\">x()</code>",
-           "<pre class=\"playground\"><code class=\"language-rust\">\n<span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}\n</span></code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust\"><span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}</span></code></pre>"),
          ("<code class=\"language-rust\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust\">fn main() {}</code></pre>"),
          ("<code class=\"language-rust editable\">let s = \"foo\n # bar\n\";</code>",
-           "<pre class=\"playground\"><code class=\"language-rust editable\">let s = \"foo\n<span class=\"boring\"> bar\n</span>\";\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust editable\">let s = \"foo\n<span class=\"boring\"> bar\n</span>\";</code></pre>"),
          ("<code class=\"language-rust editable\">let s = \"foo\n ## bar\n\";</code>",
-           "<pre class=\"playground\"><code class=\"language-rust editable\">let s = \"foo\n # bar\n\";\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust editable\">let s = \"foo\n # bar\n\";</code></pre>"),
          ("<code class=\"language-rust editable\">let s = \"foo\n # bar\n#\n\";</code>",
-           "<pre class=\"playground\"><code class=\"language-rust editable\">let s = \"foo\n<span class=\"boring\"> bar\n</span><span class=\"boring\">\n</span>\";\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust editable\">let s = \"foo\n<span class=\"boring\"> bar\n</span><span class=\"boring\">\n</span>\";</code></pre>"),
          ("<code class=\"language-rust ignore\">let s = \"foo\n # bar\n\";</code>",
-           "<code class=\"language-rust ignore\">let s = \"foo\n<span class=\"boring\"> bar\n</span>\";\n</code>"),
+           "<code class=\"language-rust ignore\">let s = \"foo\n<span class=\"boring\"> bar\n</span>\";</code>"),
          ("<code class=\"language-rust editable\">#![no_std]\nlet s = \"foo\";\n #[some_attr]</code>",
-           "<pre class=\"playground\"><code class=\"language-rust editable\">#![no_std]\nlet s = \"foo\";\n #[some_attr]\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust editable\">#![no_std]\nlet s = \"foo\";\n #[some_attr]</code></pre>"),
        ];
        for (src, should_be) in &inputs {
            let got = add_playground_pre(
@@ -1021,13 +1037,13 @@ mod tests {
    fn add_playground_edition2015() {
        let inputs = [
          ("<code class=\"language-rust\">x()</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2015\">\n<span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}\n</span></code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2015\"><span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}</span></code></pre>"),
          ("<code class=\"language-rust\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}</code></pre>"),
          ("<code class=\"language-rust edition2015\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}</code></pre>"),
          ("<code class=\"language-rust edition2018\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}</code></pre>"),
        ];
        for (src, should_be) in &inputs {
            let got = add_playground_pre(
@@ -1045,13 +1061,13 @@ mod tests {
    fn add_playground_edition2018() {
        let inputs = [
          ("<code class=\"language-rust\">x()</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2018\">\n<span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}\n</span></code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2018\"><span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}</span></code></pre>"),
          ("<code class=\"language-rust\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}</code></pre>"),
          ("<code class=\"language-rust edition2015\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}</code></pre>"),
          ("<code class=\"language-rust edition2018\">fn main() {}</code>",
-           "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}\n</code></pre>"),
+           "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}</code></pre>"),
        ];
        for (src, should_be) in &inputs {
            let got = add_playground_pre(
@@ -1069,13 +1085,13 @@ mod tests {
    fn add_playground_edition2021() {
        let inputs = [
            ("<code class=\"language-rust\">x()</code>",
-             "<pre class=\"playground\"><code class=\"language-rust edition2021\">\n<span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}\n</span></code></pre>"),
+             "<pre class=\"playground\"><code class=\"language-rust edition2021\"><span class=\"boring\">#![allow(unused)]\n</span><span class=\"boring\">fn main() {\n</span>x()\n<span class=\"boring\">}</span></code></pre>"),
            ("<code class=\"language-rust\">fn main() {}</code>",
-             "<pre class=\"playground\"><code class=\"language-rust edition2021\">fn main() {}\n</code></pre>"),
+             "<pre class=\"playground\"><code class=\"language-rust edition2021\">fn main() {}</code></pre>"),
            ("<code class=\"language-rust edition2015\">fn main() {}</code>",
-             "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}\n</code></pre>"),
+             "<pre class=\"playground\"><code class=\"language-rust edition2015\">fn main() {}</code></pre>"),
            ("<code class=\"language-rust edition2018\">fn main() {}</code>",
-             "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}\n</code></pre>"),
+             "<pre class=\"playground\"><code class=\"language-rust edition2018\">fn main() {}</code></pre>"),
        ];
        for (src, should_be) in &inputs {
            let got = add_playground_pre(
--- a/src/renderer/html_handlebars/helpers/navigation.rs
+++ b/src/renderer/html_handlebars/helpers/navigation.rs
@@ -4,6 +4,8 @@ use std::path::Path;
 use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError, Renderable};

 use crate::utils;
+use log::{debug, trace};
+use serde_json::json;

 type StringMap = BTreeMap<String, String>;

@@ -61,7 +63,7 @@ fn find_chapter(
        .as_json()
        .as_str()
        .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
-        .replace("\"", "");
+        .replace('\"', "");

    if !rc.evaluate(ctx, "@root/is_index")?.is_missing() {
        // Special case for index.md which may be a synthetic page.
@@ -121,7 +123,7 @@ fn render(
        .as_json()
        .as_str()
        .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
-        .replace("\"", "");
+        .replace('\"', "");

    context.insert(
        "path_to_root".to_owned(),
@@ -141,20 +143,17 @@ fn render(
                .with_extension("html")
                .to_str()
                .ok_or_else(|| RenderError::new("Link could not be converted to str"))
-                .map(|p| context.insert("link".to_owned(), json!(p.replace("\\", "/"))))
+                .map(|p| context.insert("link".to_owned(), json!(p.replace('\\', "/"))))
        })?;

    trace!("Render template");

-    _h.template()
-        .ok_or_else(|| RenderError::new("Error with the handlebars template"))
-        .and_then(|t| {
-            let mut local_rc = rc.clone();
-            let local_ctx = Context::wraps(&context)?;
-            t.render(r, &local_ctx, &mut local_rc, out)
-        })?;
-
-    Ok(())
+    let t = _h
+        .template()
+        .ok_or_else(|| RenderError::new("Error with the handlebars template"))?;
+    let local_ctx = Context::wraps(&context)?;
+    let mut local_rc = rc.clone();
+    t.render(r, &local_ctx, &mut local_rc, out)
 }

 pub fn previous(
--- a/src/renderer/html_handlebars/helpers/theme.rs
+++ b/src/renderer/html_handlebars/helpers/theme.rs
@@ -1,4 +1,5 @@
 use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError};
+use log::trace;

 pub fn theme_option(
    h: &Helper<'_, '_>,
--- a/src/renderer/html_handlebars/helpers/toc.rs
+++ b/src/renderer/html_handlebars/helpers/toc.rs
@@ -1,11 +1,10 @@
-use std::collections::BTreeMap;
-use std::io;
 use std::path::Path;
+use std::{cmp::Ordering, collections::BTreeMap};

 use crate::utils;
+use crate::utils::bracket_escape;

 use handlebars::{Context, Handlebars, Helper, HelperDef, Output, RenderContext, RenderError};
-use pulldown_cmark::{html, Event, Parser};

 // Handlebars helper to construct TOC
 #[derive(Clone, Copy)]
@@ -34,7 +33,7 @@ impl HelperDef for RenderToc {
            .as_json()
            .as_str()
            .ok_or_else(|| RenderError::new("Type error for `path`, string expected"))?
-            .replace("\"", "");
+            .replace('\"', "");

        let current_section = rc
            .evaluate(ctx, "@root/section")?
@@ -58,6 +57,11 @@ impl HelperDef for RenderToc {
        out.write("<ol class=\"chapter\">")?;

        let mut current_level = 1;
+        // The "index" page, which has this attribute set, is supposed to alias the first chapter in
+        // the book, i.e. the first link. There seems to be no easy way to determine which chapter
+        // the "index" is aliasing from within the renderer, so this is used instead to force the
+        // first link to be active. See further below.
+        let mut is_first_chapter = ctx.data().get("is_index").is_some();

        for item in chapters {
            // Spacer
@@ -82,61 +86,66 @@ impl HelperDef for RenderToc {
                    level - 1 < fold_level as usize
                };

-            if level > current_level {
-                while level > current_level {
-                    out.write("<li>")?;
-                    out.write("<ol class=\"section\">")?;
-                    current_level += 1;
+            match level.cmp(&current_level) {
+                Ordering::Greater => {
+                    while level > current_level {
+                        out.write("<li>")?;
+                        out.write("<ol class=\"section\">")?;
+                        current_level += 1;
+                    }
+                    write_li_open_tag(out, is_expanded, false)?;
                }
-                write_li_open_tag(out, is_expanded, false)?;
-            } else if level < current_level {
-                while level < current_level {
-                    out.write("</ol>")?;
-                    out.write("</li>")?;
-                    current_level -= 1;
+                Ordering::Less => {
+                    while level < current_level {
+                        out.write("</ol>")?;
+                        out.write("</li>")?;
+                        current_level -= 1;
+                    }
+                    write_li_open_tag(out, is_expanded, false)?;
+                }
+                Ordering::Equal => {
+                    write_li_open_tag(out, is_expanded, item.get("section").is_none())?;
                }
-                write_li_open_tag(out, is_expanded, false)?;
-            } else {
-                write_li_open_tag(out, is_expanded, item.get("section").is_none())?;
            }

            // Part title
            if let Some(title) = item.get("part") {
                out.write("<li class=\"part-title\">")?;
-                write_escaped(out, title)?;
+                out.write(&bracket_escape(title))?;
                out.write("</li>")?;
                continue;
            }

            // Link
-            let path_exists = if let Some(path) =
-                item.get("path")
-                    .and_then(|p| if p.is_empty() { None } else { Some(p) })
-            {
-                out.write("<a href=\"")?;
+            let path_exists: bool;
+            match item.get("path") {
+                Some(path) if !path.is_empty() => {
+                    out.write("<a href=\"")?;
+                    let tmp = Path::new(path)
+                        .with_extension("html")
+                        .to_str()
+                        .unwrap()
+                        // Hack for windows who tends to use `\` as separator instead of `/`
+                        .replace('\\', "/");

-                let tmp = Path::new(item.get("path").expect("Error: path should be Some(_)"))
-                    .with_extension("html")
-                    .to_str()
-                    .unwrap()
-                    // Hack for windows who tends to use `\` as separator instead of `/`
-                    .replace("\\", "/");
+                    // Add link
+                    out.write(&utils::fs::path_to_root(&current_path))?;
+                    out.write(&tmp)?;
+                    out.write("\"")?;

-                // Add link
-                out.write(&utils::fs::path_to_root(&current_path))?;
-                out.write(&tmp)?;
-                out.write("\"")?;
+                    if path == &current_path || is_first_chapter {
+                        is_first_chapter = false;
+                        out.write(" class=\"active\"")?;
+                    }

-                if path == &current_path {
-                    out.write(" class=\"active\"")?;
+                    out.write(">")?;
+                    path_exists = true;
                }
-
-                out.write(">")?;
-                true
-            } else {
-                out.write("<div>")?;
-                false
-            };
+                _ => {
+                    out.write("<div>")?;
+                    path_exists = false;
+                }
+            }

            if !self.no_section_label {
                // Section does not necessarily exist
@@ -148,20 +157,7 @@ impl HelperDef for RenderToc {
            }

            if let Some(name) = item.get("name") {
-                // Render only inline code blocks
-
-                // filter all events that are not inline code blocks
-                let parser = Parser::new(name).filter(|event| match *event {
-                    Event::Code(_) | Event::Html(_) | Event::Text(_) => true,
-                    _ => false,
-                });
-
-                // render markdown to html
-                let mut markdown_parsed_name = String::with_capacity(name.len() * 3 / 2);
-                html::push_html(&mut markdown_parsed_name, parser);
-
-                // write to the handlebars template
-                write_escaped(out, &markdown_parsed_name)?;
+                out.write(&bracket_escape(name))?
            }

            if path_exists {
@@ -205,18 +201,3 @@ fn write_li_open_tag(
    li.push_str("\">");
    out.write(&li)
 }
-
-fn write_escaped(out: &mut dyn Output, mut title: &str) -> io::Result<()> {
-    let needs_escape: &[char] = &['<', '>'];
-    while let Some(next) = title.find(needs_escape) {
-        out.write(&title[..next])?;
-        match title.as_bytes()[next] {
-            b'<' => out.write("&lt;")?,
-            b'>' => out.write("&gt;")?,
-            _ => unreachable!(),
-        }
-        title = &title[next + 1..];
-    }
-    out.write(title)?;
-    Ok(())
-}
--- a/src/renderer/html_handlebars/search.rs
+++ b/src/renderer/html_handlebars/search.rs
@@ -2,7 +2,8 @@ use std::borrow::Cow;
 use std::collections::{HashMap, HashSet};
 use std::path::Path;

-use elasticlunr::Index;
+use elasticlunr::{Index, IndexBuilder};
+use once_cell::sync::Lazy;
 use pulldown_cmark::*;

 use crate::book::{Book, BookItem};
@@ -10,10 +11,28 @@ use crate::config::Search;
 use crate::errors::*;
 use crate::theme::searcher;
 use crate::utils;
+use log::{debug, warn};
+use serde::Serialize;
+
+const MAX_WORD_LENGTH_TO_INDEX: usize = 80;
+
+/// Tokenizes in the same way as elasticlunr-rs (for English), but also drops long tokens.
+fn tokenize(text: &str) -> Vec<String> {
+    text.split(|c: char| c.is_whitespace() || c == '-')
+        .filter(|s| !s.is_empty())
+        .map(|s| s.trim().to_lowercase())
+        .filter(|s| s.len() <= MAX_WORD_LENGTH_TO_INDEX)
+        .collect()
+}

 /// Creates all files required for search.
 pub fn create_files(search_config: &Search, destination: &Path, book: &Book) -> Result<()> {
-    let mut index = Index::new(&["title", "body", "breadcrumbs"]);
+    let mut index = IndexBuilder::new()
+        .add_field_with_tokenizer("title", Box::new(&tokenize))
+        .add_field_with_tokenizer("body", Box::new(&tokenize))
+        .add_field_with_tokenizer("breadcrumbs", Box::new(&tokenize))
+        .build();
+
    let mut doc_urls = Vec::with_capacity(book.sections.len());

    for item in book.iter() {
@@ -209,12 +228,13 @@ fn write_to_json(index: Index, search_config: &Search, doc_urls: Vec<String>) ->

    let mut fields = BTreeMap::new();
    let mut opt = SearchOptionsField::default();
-    opt.boost = Some(search_config.boost_title);
-    fields.insert("title".into(), opt);
-    opt.boost = Some(search_config.boost_paragraph);
-    fields.insert("body".into(), opt);
-    opt.boost = Some(search_config.boost_hierarchy);
-    fields.insert("breadcrumbs".into(), opt);
+    let mut insert_boost = |key: &str, boost| {
+        opt.boost = Some(boost);
+        fields.insert(key.into(), opt);
+    };
+    insert_boost("title", search_config.boost_title);
+    insert_boost("body", search_config.boost_paragraph);
+    insert_boost("breadcrumbs", search_config.boost_hierarchy);

    let search_options = SearchOptions {
        bool: if search_config.use_boolean_and {
@@ -247,21 +267,19 @@ fn write_to_json(index: Index, search_config: &Search, doc_urls: Vec<String>) ->
 }

 fn clean_html(html: &str) -> String {
-    lazy_static! {
-        static ref AMMONIA: ammonia::Builder<'static> = {
-            let mut clean_content = HashSet::new();
-            clean_content.insert("script");
-            clean_content.insert("style");
-            let mut builder = ammonia::Builder::new();
-            builder
-                .tags(HashSet::new())
-                .tag_attributes(HashMap::new())
-                .generic_attributes(HashSet::new())
-                .link_rel(None)
-                .allowed_classes(HashMap::new())
-                .clean_content_tags(clean_content);
-            builder
-        };
-    }
+    static AMMONIA: Lazy<ammonia::Builder<'static>> = Lazy::new(|| {
+        let mut clean_content = HashSet::new();
+        clean_content.insert("script");
+        clean_content.insert("style");
+        let mut builder = ammonia::Builder::new();
+        builder
+            .tags(HashSet::new())
+            .tag_attributes(HashMap::new())
+            .generic_attributes(HashSet::new())
+            .link_rel(None)
+            .allowed_classes(HashMap::new())
+            .clean_content_tags(clean_content);
+        builder
+    });
    AMMONIA.clean(html).to_string()
 }
--- a/src/renderer/markdown_renderer.rs
+++ b/src/renderer/markdown_renderer.rs
@@ -2,7 +2,7 @@ use crate::book::BookItem;
 use crate::errors::*;
 use crate::renderer::{RenderContext, Renderer};
 use crate::utils;
-
+use log::trace;
 use std::fs;

 #[derive(Default)]
--- a/src/renderer/mod.rs
+++ b/src/renderer/mod.rs
@@ -27,8 +27,11 @@ use std::process::{Command, Stdio};
 use crate::book::Book;
 use crate::config::Config;
 use crate::errors::*;
+use log::{error, info, trace, warn};
 use toml::Value;

+use serde::{Deserialize, Serialize};
+
 /// An arbitrary `mdbook` backend.
 ///
 /// Although it's quite possible for you to import `mdbook` as a library and
--- a/src/theme/ayu-highlight.css
+++ b/src/theme/ayu-highlight.css
@@ -8,7 +8,6 @@ Original by Dempfi (https://github.com/dempfi/ayu)
  overflow-x: auto;
  background: #191f26;
  color: #e6e1cf;
-  padding: 0.5em;
 }

 .hljs-comment,
--- a/src/theme/book.js
+++ b/src/theme/book.js
@@ -11,7 +11,7 @@ function playground_text(playground) {
        let editor = window.ace.edit(code_block);
        return editor.getValue();
    } else {
-        return code_block.textContent;
+        return code_block.innerText;
    }
 }

@@ -300,6 +300,13 @@ function playground_text(playground) {
        themePopup.querySelector("button#" + get_theme()).focus();
    }

+    function updateThemeSelected() {
+        themePopup.querySelectorAll('.theme-selected').forEach(function (el) {
+            el.classList.remove('theme-selected');
+        });
+        themePopup.querySelector("button#" + get_theme()).classList.add('theme-selected');
+    }
+
    function hideThemes() {
        themePopup.style.display = 'none';
        themeToggleButton.setAttribute('aria-expanded', false);
@@ -355,6 +362,7 @@ function playground_text(playground) {

        html.classList.remove(previousTheme);
        html.classList.add(theme);
+        updateThemeSelected();
    }

    // Set theme
--- a/src/theme/css/chrome.css
+++ b/src/theme/css/chrome.css
@@ -208,24 +208,63 @@ pre {
 pre > .buttons {
    position: absolute;
    z-index: 100;
-    right: 5px;
-    top: 5px;
+    right: 0px;
+    top: 2px;
+    margin: 0px;
+    padding: 2px 0px;

    color: var(--sidebar-fg);
    cursor: pointer;
+    visibility: hidden;
+    opacity: 0;
+    transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+    visibility: visible;
+    opacity: 1
 }
 pre > .buttons :hover {
    color: var(--sidebar-active);
+    border-color: var(--icons-hover);
+    background-color: var(--theme-hover);
 }
 pre > .buttons i {
    margin-left: 8px;
 }
 pre > .buttons button {
-    color: inherit;
-    background: transparent;
-    border: none;
    cursor: inherit;
+    margin: 0px 5px;
+    padding: 3px 5px;
+    font-size: 14px;
+
+    border-style: solid;
+    border-width: 1px;
+    border-radius: 4px;
+    border-color: var(--icons);
+    background-color: var(--theme-popup-bg);
+    transition: 100ms;
+    transition-property: color,border-color,background-color;
+    color: var(--icons);
 }
+@media (pointer: coarse) {
+    pre > .buttons button {
+        /* On mobile, make it easier to tap buttons. */
+        padding: 0.3rem 1rem;
+    }
+}
+pre > code {
+    padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+   positioning within the code block which breaks padding. The only solution I
+   can think of is to move the padding to the outer pre tag (or insert a div
+   wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+  padding: 0rem 0rem;
+}
+
 pre > .result {
    margin-top: 10px;
 }
@@ -468,6 +507,8 @@ ul#searchresults span.teaser em {
    padding: 0;
    list-style: none;
    display: none;
+    /* Don't let the children's background extend past the rounded corners. */
+    overflow: hidden;
 }
 .theme-popup .default {
    color: var(--icons);
@@ -476,7 +517,7 @@ ul#searchresults span.teaser em {
    width: 100%;
    border: 0;
    margin: 0;
-    padding: 2px 10px;
+    padding: 2px 20px;
    line-height: 25px;
    white-space: nowrap;
    text-align: left;
@@ -488,8 +529,10 @@ ul#searchresults span.teaser em {
 .theme-popup .theme:hover {
    background-color: var(--theme-hover);
 }
-.theme-popup .theme:hover:first-child,
-.theme-popup .theme:hover:last-child {
-    border-top-left-radius: inherit;
-    border-top-right-radius: inherit;
+
+.theme-selected::before {
+    display: inline-block;
+    content: "✓";
+    margin-left: -14px;
+    width: 14px;
 }
--- a/src/theme/css/general.css
+++ b/src/theme/css/general.css
@@ -22,8 +22,18 @@ body {
 }

 code {
-    font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
-    font-size: 0.875em; /* please adjust the ace font size accordingly in editor.js */
+    font-family: var(--mono-font) !important;
+    font-size: var(--code-font-size);
+}
+
+/* make long words/inline code not x overflow */
+main {
+    overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+    overflow-x: auto;
 }

 /* Don't change font size in headers. */
@@ -80,8 +90,7 @@ h6:target::before {

 .content {
    overflow-y: auto;
-    padding: 0 15px;
-    padding-bottom: 50px;
+    padding: 0 5px 50px 5px;
 }
 .content main {
    margin-left: auto;
@@ -139,6 +148,18 @@ blockquote {
    border-bottom: .1em solid var(--quote-border);
 }

+kbd {
+    background-color: var(--table-border-color);
+    border-radius: 4px;
+    border: solid 1px var(--theme-popup-border);
+    box-shadow: inset 0 -1px 0 var(--theme-hover);
+    display: inline-block;
+    font-size: var(--code-font-size);
+    font-family: var(--mono-font);
+    line-height: 10px;
+    padding: 4px 5px;
+    vertical-align: middle;
+}

 :not(.footnote-definition) + .footnote-definition,
 .footnote-definition + :not(.footnote-definition) {
--- a/src/theme/css/variables.css
+++ b/src/theme/css/variables.css
@@ -6,6 +6,8 @@
    --page-padding: 15px;
    --content-max-width: 750px;
    --menu-bar-height: 50px;
+    --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+    --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
 }

 /* Themes */
--- a/src/theme/highlight.css
+++ b/src/theme/highlight.css
@@ -61,7 +61,6 @@
  overflow-x: auto;
  background: #f6f7f6;
  color: #000;
-  padding: 0.5em;
 }

 .hljs-emphasis {
--- a/src/theme/index.hbs
+++ b/src/theme/index.hbs
@@ -15,7 +15,6 @@
        <!-- Custom HTML head -->
        {{> head}}

-        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <meta name="description" content="{{ description }}">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <meta name="theme-color" content="#ffffff" />
@@ -51,18 +50,18 @@

        {{#if mathjax_support}}
        <!-- MathJax -->
-        <script async type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
+        <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
        {{/if}}
    </head>
    <body>
        <!-- Provide site root to javascript -->
-        <script type="text/javascript">
+        <script>
            var path_to_root = "{{ path_to_root }}";
            var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "{{ preferred_dark_theme }}" : "{{ default_theme }}";
        </script>

        <!-- Work around some values being stored in localStorage wrapped in quotes -->
-        <script type="text/javascript">
+        <script>
            try {
                var theme = localStorage.getItem('mdbook-theme');
                var sidebar = localStorage.getItem('mdbook-sidebar');
@@ -78,7 +77,7 @@
        </script>

        <!-- Set the theme before any content is loaded, prevents flash -->
-        <script type="text/javascript">
+        <script>
            var theme;
            try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
            if (theme === null || theme === undefined) { theme = default_theme; }
@@ -90,7 +89,7 @@
        </script>

        <!-- Hide / unhide sidebar before it is displayed -->
-        <script type="text/javascript">
+        <script>
            var html = document.querySelector('html');
            var sidebar = 'hidden';
            if (document.body.clientWidth >= 1080) {
@@ -122,11 +121,11 @@
                            <i class="fa fa-paint-brush"></i>
                        </button>
                        <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
-                            <li role="none"><button role="menuitem" class="theme" id="light">{{ theme_option "Light" }}</button></li>
-                            <li role="none"><button role="menuitem" class="theme" id="rust">{{ theme_option "Rust" }}</button></li>
-                            <li role="none"><button role="menuitem" class="theme" id="coal">{{ theme_option "Coal" }}</button></li>
-                            <li role="none"><button role="menuitem" class="theme" id="navy">{{ theme_option "Navy" }}</button></li>
-                            <li role="none"><button role="menuitem" class="theme" id="ayu">{{ theme_option "Ayu" }}</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
+                            <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
                        </ul>
                        {{#if search_enabled}}
                        <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
@@ -171,7 +170,7 @@
                {{/if}}

                <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
-                <script type="text/javascript">
+                <script>
                    document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
                    document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
                    Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
@@ -221,7 +220,7 @@

        {{#if live_reload_endpoint}}
        <!-- Livereload script (if served using the cli tool) -->
-        <script type="text/javascript">
+        <script>
            const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
            const wsAddress = wsProtocol + "//" + location.host + "/" + "{{{live_reload_endpoint}}}";
            const socket = new WebSocket(wsAddress);
@@ -240,7 +239,7 @@

        {{#if google_analytics}}
        <!-- Google Analytics Tag -->
-        <script type="text/javascript">
+        <script>
            var localAddrs = ["localhost", "127.0.0.1", ""];

            // make sure we don't activate google analytics if the developer is
@@ -258,43 +257,43 @@
        {{/if}}

        {{#if playground_line_numbers}}
-        <script type="text/javascript">
+        <script>
            window.playground_line_numbers = true;
        </script>
        {{/if}}

        {{#if playground_copyable}}
-        <script type="text/javascript">
+        <script>
            window.playground_copyable = true;
        </script>
        {{/if}}

        {{#if playground_js}}
-        <script src="{{ path_to_root }}ace.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}editor.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}mode-rust.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}theme-dawn.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}theme-tomorrow_night.js" type="text/javascript" charset="utf-8"></script>
+        <script src="{{ path_to_root }}ace.js"></script>
+        <script src="{{ path_to_root }}editor.js"></script>
+        <script src="{{ path_to_root }}mode-rust.js"></script>
+        <script src="{{ path_to_root }}theme-dawn.js"></script>
+        <script src="{{ path_to_root }}theme-tomorrow_night.js"></script>
        {{/if}}

        {{#if search_js}}
-        <script src="{{ path_to_root }}elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}mark.min.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}searcher.js" type="text/javascript" charset="utf-8"></script>
+        <script src="{{ path_to_root }}elasticlunr.min.js"></script>
+        <script src="{{ path_to_root }}mark.min.js"></script>
+        <script src="{{ path_to_root }}searcher.js"></script>
        {{/if}}

-        <script src="{{ path_to_root }}clipboard.min.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}highlight.js" type="text/javascript" charset="utf-8"></script>
-        <script src="{{ path_to_root }}book.js" type="text/javascript" charset="utf-8"></script>
+        <script src="{{ path_to_root }}clipboard.min.js"></script>
+        <script src="{{ path_to_root }}highlight.js"></script>
+        <script src="{{ path_to_root }}book.js"></script>

        <!-- Custom JS scripts -->
        {{#each additional_js}}
-        <script type="text/javascript" src="{{ ../path_to_root }}{{this}}"></script>
+        <script src="{{ ../path_to_root }}{{this}}"></script>
        {{/each}}

        {{#if is_print}}
        {{#if mathjax_support}}
-        <script type="text/javascript">
+        <script>
        window.addEventListener('load', function() {
            MathJax.Hub.Register.StartupHook('End', function() {
                window.setTimeout(window.print, 100);
@@ -302,7 +301,7 @@
        });
        </script>
        {{else}}
-        <script type="text/javascript">
+        <script>
        window.addEventListener('load', function() {
            window.setTimeout(window.print, 100);
        });
--- a/src/theme/mod.rs
+++ b/src/theme/mod.rs
@@ -12,7 +12,7 @@ use std::io::Read;
 use std::path::Path;

 use crate::errors::*;
-
+use log::warn;
 pub static INDEX: &[u8] = include_bytes!("index.hbs");
 pub static HEAD: &[u8] = include_bytes!("head.hbs");
 pub static REDIRECT: &[u8] = include_bytes!("redirect.hbs");
--- a/src/theme/redirect.hbs
+++ b/src/theme/redirect.hbs
@@ -3,8 +3,8 @@
  <head>
    <meta charset="utf-8">
    <title>Redirecting...</title>
-    <meta http-equiv="refresh" content="0;URL='{{url}}'">
-    <meta rel="canonical" href="{{url}}">
+    <meta http-equiv="refresh" content="0; URL={{url}}">
+    <link rel="canonical" href="{{url}}">
  </head>
  <body>
      <p>Redirecting to... <a href="{{url}}">{{url}}</a>.</p>
--- a/src/theme/tomorrow-night.css
+++ b/src/theme/tomorrow-night.css
@@ -81,8 +81,6 @@
  overflow-x: auto;
  background: #1d1f21;
  color: #c5c8c6;
-  padding: 0.5em;
-  -webkit-text-size-adjust: none;
 }

 .coffeescript .javascript,
--- a/src/utils/fs.rs
+++ b/src/utils/fs.rs
@@ -1,4 +1,5 @@
 use crate::errors::*;
+use log::{debug, trace};
 use std::convert::Into;
 use std::fs::{self, File};
 use std::io::Write;
--- a/src/utils/mod.rs
+++ b/src/utils/mod.rs
@@ -4,9 +4,10 @@ pub mod fs;
 mod string;
 pub(crate) mod toml_ext;
 use crate::errors::Error;
-use regex::Regex;
-
+use log::error;
+use once_cell::sync::Lazy;
 use pulldown_cmark::{html, CodeBlockKind, CowStr, Event, Options, Parser, Tag};
+use regex::Regex;

 use std::borrow::Cow;
 use std::collections::HashMap;
@@ -20,9 +21,7 @@ pub use self::string::{

 /// Replaces multiple consecutive whitespace characters with a single space character.
 pub fn collapse_whitespace(text: &str) -> Cow<'_, str> {
-    lazy_static! {
-        static ref RE: Regex = Regex::new(r"\s\s+").unwrap();
-    }
+    static RE: Lazy<Regex> = Lazy::new(|| Regex::new(r"\s\s+").unwrap());
    RE.replace_all(text, " ")
 }

@@ -51,9 +50,7 @@ pub fn id_from_content(content: &str) -> String {
    let mut content = content.to_string();

    // Skip any tags or html-encoded stuff
-    lazy_static! {
-        static ref HTML: Regex = Regex::new(r"(<.*?>)").unwrap();
-    }
+    static HTML: Lazy<Regex> = Lazy::new(|| Regex::new(r"(<.*?>)").unwrap());
    content = HTML.replace_all(&content, "").into();
    const REPL_SUB: &[&str] = &["&lt;", "&gt;", "&amp;", "&#39;", "&quot;"];
    for sub in REPL_SUB {
@@ -96,10 +93,9 @@ pub fn unique_id_from_content(content: &str, id_counter: &mut HashMap<String, us
 /// None. Ideally, print page links would link to anchors on the print page,
 /// but that is very difficult.
 fn adjust_links<'a>(event: Event<'a>, path: Option<&Path>) -> Event<'a> {
-    lazy_static! {
-        static ref SCHEME_LINK: Regex = Regex::new(r"^[a-z][a-z0-9+.-]*:").unwrap();
-        static ref MD_LINK: Regex = Regex::new(r"(?P<link>.*)\.md(?P<anchor>#.*)?").unwrap();
-    }
+    static SCHEME_LINK: Lazy<Regex> = Lazy::new(|| Regex::new(r"^[a-z][a-z0-9+.-]*:").unwrap());
+    static MD_LINK: Lazy<Regex> =
+        Lazy::new(|| Regex::new(r"(?P<link>.*)\.md(?P<anchor>#.*)?").unwrap());

    fn fix<'a>(dest: CowStr<'a>, path: Option<&Path>) -> CowStr<'a> {
        if dest.starts_with('#') {
@@ -152,10 +148,8 @@ fn adjust_links<'a>(event: Event<'a>, path: Option<&Path>) -> Event<'a> {
        // There are dozens of HTML tags/attributes that contain paths, so
        // feel free to add more tags if desired; these are the only ones I
        // care about right now.
-        lazy_static! {
-            static ref HTML_LINK: Regex =
-                Regex::new(r#"(<(?:a|img) [^>]*?(?:src|href)=")([^"]+?)""#).unwrap();
-        }
+        static HTML_LINK: Lazy<Regex> =
+            Lazy::new(|| Regex::new(r#"(<(?:a|img) [^>]*?(?:src|href)=")([^"]+?)""#).unwrap());

        HTML_LINK
            .replace_all(&html, |caps: &regex::Captures<'_>| {
@@ -200,12 +194,28 @@ pub fn render_markdown_with_path(text: &str, curly_quotes: bool, path: Option<&P
    let p = new_cmark_parser(text, curly_quotes);
    let events = p
        .map(clean_codeblock_headers)
-        .map(|event| adjust_links(event, path));
+        .map(|event| adjust_links(event, path))
+        .flat_map(|event| {
+            let (a, b) = wrap_tables(event);
+            a.into_iter().chain(b)
+        });

    html::push_html(&mut s, events);
    s
 }

+/// Wraps tables in a `.table-wrapper` class to apply overflow-x rules to.
+fn wrap_tables(event: Event<'_>) -> (Option<Event<'_>>, Option<Event<'_>>) {
+    match event {
+        Event::Start(Tag::Table(_)) => (
+            Some(Event::Html(r#"<div class="table-wrapper">"#.into())),
+            Some(event),
+        ),
+        Event::End(Tag::Table(_)) => (Some(event), Some(Event::Html(r#"</div>"#.into()))),
+        _ => (Some(event), None),
+    }
+}
+
 fn clean_codeblock_headers(event: Event<'_>) -> Event<'_> {
    match event {
        Event::Start(Tag::CodeBlock(CodeBlockKind::Fenced(ref info))) => {
@@ -233,8 +243,26 @@ pub fn log_backtrace(e: &Error) {
    }
 }

+pub(crate) fn bracket_escape(mut s: &str) -> String {
+    let mut escaped = String::with_capacity(s.len());
+    let needs_escape: &[char] = &['<', '>'];
+    while let Some(next) = s.find(needs_escape) {
+        escaped.push_str(&s[..next]);
+        match s.as_bytes()[next] {
+            b'<' => escaped.push_str("&lt;"),
+            b'>' => escaped.push_str("&gt;"),
+            _ => unreachable!(),
+        }
+        s = &s[next + 1..];
+    }
+    escaped.push_str(s);
+    escaped
+}
+
 #[cfg(test)]
 mod tests {
+    use super::bracket_escape;
+
    mod render_markdown {
        use super::super::render_markdown;

@@ -264,6 +292,22 @@ mod tests {
            );
        }

+        #[test]
+        fn it_can_wrap_tables() {
+            let src = r#"
+| Original        | Punycode        | Punycode + Encoding |
+|-----------------|-----------------|---------------------|
+| føø             | f-5gaa          | f_5gaa              |
+"#;
+            let out = r#"
+<div class="table-wrapper"><table><thead><tr><th>Original</th><th>Punycode</th><th>Punycode + Encoding</th></tr></thead><tbody>
+<tr><td>føø</td><td>f-5gaa</td><td>f_5gaa</td></tr>
+</tbody></table>
+</div>
+"#.trim();
+            assert_eq!(render_markdown(src, false), out);
+        }
+
        #[test]
        fn it_can_keep_quotes_straight() {
            assert_eq!(render_markdown("'one'", false), "<p>'one'</p>\n");
@@ -431,4 +475,14 @@ more text with spaces
            assert_eq!(unique_id_from_content("## Über", &mut id_counter), "Über-2");
        }
    }
+
+    #[test]
+    fn escaped_brackets() {
+        assert_eq!(bracket_escape(""), "");
+        assert_eq!(bracket_escape("<"), "&lt;");
+        assert_eq!(bracket_escape(">"), "&gt;");
+        assert_eq!(bracket_escape("<>"), "&lt;&gt;");
+        assert_eq!(bracket_escape("<test>"), "&lt;test&gt;");
+        assert_eq!(bracket_escape("a<test>b"), "a&lt;test&gt;b");
+    }
 }
--- a/src/utils/string.rs
+++ b/src/utils/string.rs
@@ -1,3 +1,4 @@
+use once_cell::sync::Lazy;
 use regex::Regex;
 use std::ops::Bound::{Excluded, Included, Unbounded};
 use std::ops::RangeBounds;
@@ -23,10 +24,10 @@ pub fn take_lines<R: RangeBounds<usize>>(s: &str, range: R) -> String {
    }
 }

-lazy_static! {
-    static ref ANCHOR_START: Regex = Regex::new(r"ANCHOR:\s*(?P<anchor_name>[\w_-]+)").unwrap();
-    static ref ANCHOR_END: Regex = Regex::new(r"ANCHOR_END:\s*(?P<anchor_name>[\w_-]+)").unwrap();
-}
+static ANCHOR_START: Lazy<Regex> =
+    Lazy::new(|| Regex::new(r"ANCHOR:\s*(?P<anchor_name>[\w_-]+)").unwrap());
+static ANCHOR_END: Lazy<Regex> =
+    Lazy::new(|| Regex::new(r"ANCHOR_END:\s*(?P<anchor_name>[\w_-]+)").unwrap());

 /// Take anchored lines from a string.
 /// Lines containing anchor are ignored.
@@ -122,6 +123,7 @@ mod tests {
    };

    #[test]
+    #[allow(clippy::reversed_empty_ranges)] // Intentionally checking that those are correctly handled
    fn take_lines_test() {
        let s = "Lorem\nipsum\ndolor\nsit\namet";
        assert_eq!(take_lines(s, 1..3), "ipsum\ndolor");
@@ -163,6 +165,7 @@ mod tests {
    }

    #[test]
+    #[allow(clippy::reversed_empty_ranges)] // Intentionally checking that those are correctly handled
    fn take_rustdoc_include_lines_test() {
        let s = "Lorem\nipsum\ndolor\nsit\namet";
        assert_eq!(
--- a/test_book/src/individual/mixed.md
+++ b/test_book/src/individual/mixed.md
@@ -27,6 +27,8 @@ fn main(){
 }
 ```

+<kbd>Ctrl</kbd> + <kbd>S</kbd> saves a file.
+
 A random image sprinkled in between

 ![16x16 rust-lang logo](http://rust-lang.org/logos/rust-logo-16x16.png)
@@ -41,6 +43,7 @@ A random image sprinkled in between
  2. be
  3. `put`
  4. here?
+  5. **<kbd>Ctrl</kbd> + <kbd>S</kbd> saves a file.**

 | col1 | col2 | col 3 | col 4 | col 5 | col 6 |
 | ---- | ---- | ----- | ----- | ----- | ----- |
--- a/tests/cli/build.rs
+++ b/tests/cli/build.rs
@@ -1,7 +1,6 @@
+use crate::cli::cmd::mdbook_cmd;
 use crate::dummy_book::DummyBook;

-use assert_cmd::Command;
-
 #[test]
 fn mdbook_cli_dummy_book_generates_index_html() {
    let temp = DummyBook::new().build().unwrap();
@@ -9,7 +8,7 @@ fn mdbook_cli_dummy_book_generates_index_html() {
    // doesn't exist before
    assert!(!temp.path().join("book").exists());

-    let mut cmd = Command::cargo_bin("mdbook").unwrap();
+    let mut cmd = mdbook_cmd();
    cmd.arg("build").current_dir(temp.path());
    cmd.assert()
        .success()
--- a/tests/cli/cmd.rs
+++ b/tests/cli/cmd.rs
@@ -0,0 +1,7 @@
+use assert_cmd::Command;
+
+pub(crate) fn mdbook_cmd() -> Command {
+    let mut cmd = Command::cargo_bin("mdbook").unwrap();
+    cmd.env_remove("RUST_LOG");
+    cmd
+}
--- a/tests/cli/mod.rs
+++ b/tests/cli/mod.rs
@@ -1,2 +1,3 @@
 mod build;
+mod cmd;
 mod test;
--- a/tests/cli/test.rs
+++ b/tests/cli/test.rs
@@ -1,20 +1,20 @@
+use crate::cli::cmd::mdbook_cmd;
 use crate::dummy_book::DummyBook;

-use assert_cmd::Command;
 use predicates::boolean::PredicateBooleanExt;

 #[test]
 fn mdbook_cli_can_correctly_test_a_passing_book() {
    let temp = DummyBook::new().with_passing_test(true).build().unwrap();

-    let mut cmd = Command::cargo_bin("mdbook").unwrap();
+    let mut cmd = mdbook_cmd();
    cmd.arg("test").current_dir(temp.path());
    cmd.assert().success()
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]README.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]intro.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]first[\\/]index.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]first[\\/]nested.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"rustdoc returned an error:\n\n"##).unwrap().not())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "README.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "intro.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "first[\\/]index.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "first[\\/]nested.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"returned an error:\n\n"##).unwrap().not())
      .stderr(predicates::str::is_match(r##"Nested_Chapter::Rustdoc_include_works_with_anchors_too \(line \d+\) ... FAILED"##).unwrap().not());
 }

@@ -22,13 +22,13 @@ fn mdbook_cli_can_correctly_test_a_passing_book() {
 fn mdbook_cli_detects_book_with_failing_tests() {
    let temp = DummyBook::new().with_passing_test(false).build().unwrap();

-    let mut cmd = Command::cargo_bin("mdbook").unwrap();
+    let mut cmd = mdbook_cmd();
    cmd.arg("test").current_dir(temp.path());
    cmd.assert().failure()
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]README.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]intro.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]first[\\/]index.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"Testing file: "([^"]+)[\\/]first[\\/]nested.md""##).unwrap())
-      .stderr(predicates::str::is_match(r##"rustdoc returned an error:\n\n"##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "README.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "intro.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "first[\\/]index.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"Testing chapter [^:]*: "first[\\/]nested.md""##).unwrap())
+      .stderr(predicates::str::is_match(r##"returned an error:\n\n"##).unwrap())
      .stderr(predicates::str::is_match(r##"Nested_Chapter::Rustdoc_include_works_with_anchors_too \(line \d+\) ... FAILED"##).unwrap());
 }
--- a/tests/dummy_book/index_html_test/SUMMARY.md
+++ b/tests/dummy_book/index_html_test/SUMMARY.md
@@ -0,0 +1,11 @@
+# Summary
+
+---
+
+- [None of these should be treated as the "index chapter"]()
+
+# Part 1
+
+- [Not this either]()
+- [Chapter 1](./chapter_1.md)
+- [And not this]()
--- a/tests/dummy_book/index_html_test/chapter_1.md
+++ b/tests/dummy_book/index_html_test/chapter_1.md
@@ -0,0 +1 @@
+# Chapter 1
--- a/tests/dummy_book/src/first/no-headers.md
+++ b/tests/dummy_book/src/first/no-headers.md
@@ -1,3 +1,5 @@
 Capybara capybara capybara.

-Capybara capybara capybara.
+Capybara capybara capybara.
+
+ThisLongWordIsIncludedSoWeCanCheckThatSufficientlyLongWordsAreOmittedFromTheSearchIndex.
--- a/tests/dummy_book/summary-formatting/SUMMARY.md
+++ b/tests/dummy_book/summary-formatting/SUMMARY.md
@@ -0,0 +1,6 @@
+# Summary formatting tests
+
+- [*Italic* `code` \*escape\* \`escape2\`](formatted-summary.md)
+- [Soft
+line break](soft.md)
+- [\<escaped tag\>](escaped-tag.md)
--- a/tests/init.rs
+++ b/tests/init.rs
@@ -95,7 +95,7 @@ fn run_mdbook_init_with_custom_book_and_src_locations() {
    let contents = fs::read_to_string(temp.path().join("book.toml")).unwrap();
    assert_eq!(
        contents,
-        "[book]\nauthors = []\nlanguage = \"en\"\nmultilingual = false\nsrc = \"in\"\n\n[build]\nbuild-dir = \"out\"\ncreate-missing = true\nuse-default-preprocessors = true\n"
+        "[book]\nauthors = []\nlanguage = \"en\"\nmultilingual = false\nsrc = \"in\"\n\n[build]\nbuild-dir = \"out\"\ncreate-missing = true\nextra-watch-dirs = []\nuse-default-preprocessors = true\n"
    );
 }

--- a/tests/rendered_output.rs
+++ b/tests/rendered_output.rs
@@ -467,6 +467,21 @@ fn by_default_mdbook_use_index_preprocessor_to_convert_readme_to_index() {
    assert_doesnt_contain_strings(&second_index, &unexpected_strings);
 }

+#[test]
+fn first_chapter_is_copied_as_index_even_if_not_first_elem() {
+    let temp = DummyBook::new().build().unwrap();
+    let mut cfg = Config::default();
+    cfg.set("book.src", "index_html_test")
+        .expect("Couldn't set config.book.src to \"index_html_test\"");
+    let md = MDBook::load_with_config(temp.path(), cfg).unwrap();
+    md.build().unwrap();
+
+    let root = temp.path().join("book");
+    let chapter = fs::read_to_string(root.join("chapter_1.html")).expect("read chapter 1");
+    let index = fs::read_to_string(root.join("index.html")).expect("read index");
+    pretty_assertions::assert_eq!(chapter, index);
+}
+
 #[test]
 fn theme_dir_overrides_work_correctly() {
    let book_dir = dummy_book::new_copy_of_example_book().unwrap();
@@ -621,6 +636,93 @@ fn remove_absolute_components(path: &Path) -> impl Iterator<Item = Component> +
    })
 }

+/// Checks formatting of summary names with inline elements.
+#[test]
+fn summary_with_markdown_formatting() {
+    let temp = DummyBook::new().build().unwrap();
+    let mut cfg = Config::default();
+    cfg.set("book.src", "summary-formatting").unwrap();
+    let md = MDBook::load_with_config(temp.path(), cfg).unwrap();
+    md.build().unwrap();
+
+    let rendered_path = temp.path().join("book/formatted-summary.html");
+    assert_contains_strings(
+        rendered_path,
+        &[
+            r#"<a href="formatted-summary.html" class="active"><strong aria-hidden="true">1.</strong> Italic code *escape* `escape2`</a>"#,
+            r#"<a href="soft.html"><strong aria-hidden="true">2.</strong> Soft line break</a>"#,
+            r#"<a href="escaped-tag.html"><strong aria-hidden="true">3.</strong> &lt;escaped tag&gt;</a>"#,
+        ],
+    );
+
+    let generated_md = temp.path().join("summary-formatting/formatted-summary.md");
+    assert_eq!(
+        fs::read_to_string(generated_md).unwrap(),
+        "# Italic code *escape* `escape2`\n"
+    );
+    let generated_md = temp.path().join("summary-formatting/soft.md");
+    assert_eq!(
+        fs::read_to_string(generated_md).unwrap(),
+        "# Soft line break\n"
+    );
+    let generated_md = temp.path().join("summary-formatting/escaped-tag.md");
+    assert_eq!(
+        fs::read_to_string(generated_md).unwrap(),
+        "# &lt;escaped tag&gt;\n"
+    );
+}
+
+/// Ensure building fails if `[output.html].theme` points to a non-existent directory
+#[test]
+fn failure_on_missing_theme_directory() {
+    // 1. Using default theme should work
+    let temp = DummyBook::new().build().unwrap();
+    let book_toml = r#"
+        [book]
+        title = "implicit"
+        src = "src"
+        "#;
+
+    write_file(temp.path(), "book.toml", book_toml.as_bytes()).unwrap();
+    let md = MDBook::load(temp.path()).unwrap();
+    let got = md.build();
+    assert!(got.is_ok());
+
+    // 2. Pointing to a normal directory should work
+    let temp = DummyBook::new().build().unwrap();
+    let created = fs::create_dir(temp.path().join("theme-directory"));
+    assert!(created.is_ok());
+    let book_toml = r#"
+        [book]
+        title = "implicit"
+        src = "src"
+
+        [output.html]
+        theme = "./theme-directory"
+        "#;
+
+    write_file(temp.path(), "book.toml", book_toml.as_bytes()).unwrap();
+    let md = MDBook::load(temp.path()).unwrap();
+    let got = md.build();
+    assert!(got.is_ok());
+
+    // 3. Pointing to a non-existent directory should fail
+    let temp = DummyBook::new().build().unwrap();
+    let book_toml = r#"
+        [book]
+        title = "implicit"
+        src = "src"
+
+        [output.html]
+        theme = "./non-existent-directory"
+        "#;
+
+    write_file(temp.path(), "book.toml", book_toml.as_bytes()).unwrap();
+    let md = MDBook::load(temp.path()).unwrap();
+    let got = md.build();
+    assert!(got.is_err());
+}
+
 #[cfg(feature = "search")]
 mod search {
    use crate::dummy_book::DummyBook;
@@ -685,7 +787,7 @@ mod search {
        );
        assert_eq!(
            docs[&no_headers]["body"],
-            "Capybara capybara capybara. Capybara capybara capybara."
+            "Capybara capybara capybara. Capybara capybara capybara. ThisLongWordIsIncludedSoWeCanCheckThatSufficientlyLongWordsAreOmittedFromTheSearchIndex."
        );
    }

--- a/tests/searchindex_fixture.json
+++ b/tests/searchindex_fixture.json
@@ -229,7 +229,7 @@
          "title": "Unicode stress tests"
        },
        "18": {
-          "body": "Capybara capybara capybara. Capybara capybara capybara.",
+          "body": "Capybara capybara capybara. Capybara capybara capybara. ThisLongWordIsIncludedSoWeCanCheckThatSufficientlyLongWordsAreOmittedFromTheSearchIndex.",
          "breadcrumbs": "First Chapter » No Headers",
          "id": "18",
          "title": "First Chapter"
--- a/tests/testing.rs
+++ b/tests/testing.rs
@@ -24,3 +24,24 @@ fn mdbook_detects_book_with_failing_tests() {

    assert!(md.test(vec![]).is_err());
 }
+
+#[test]
+fn mdbook_test_chapter() {
+    let temp = DummyBook::new().with_passing_test(true).build().unwrap();
+    let mut md = MDBook::load(temp.path()).unwrap();
+
+    let result = md.test_chapter(vec![], Some("Introduction"));
+    assert!(
+        result.is_ok(),
+        "test_chapter failed with {}",
+        result.err().unwrap()
+    );
+}
+
+#[test]
+fn mdbook_test_chapter_not_found() {
+    let temp = DummyBook::new().with_passing_test(true).build().unwrap();
+    let mut md = MDBook::load(temp.path()).unwrap();
+
+    assert!(md.test_chapter(vec![], Some("Bogus Chapter Name")).is_err());
+}
Author	SHA1	Message	Date
Eric Huss	678b469835	Merge pull request #1938 from ehuss/bump-version Update to 0.4.22	2022-11-28 10:16:18 -08:00
Eric Huss	ded48ddac7	Update to 0.4.22	2022-11-28 09:54:39 -08:00
Eric Huss	8a02fc755f	Fix broken doc link	2022-11-28 09:53:47 -08:00
Dylan DPC	4844f72b96	Merge pull request #1935 from ehuss/theme-dropdown-rendering-changes Show the currently selected theme	2022-11-22 13:32:12 +05:30
Eric Huss	f32bd6f945	Show the currently selected theme.	2022-11-21 15:27:39 -08:00
Eric Huss	f64fcbc07d	Fix clipping in theme popup	2022-11-21 14:00:18 -08:00
Eric Huss	c34c3bf730	Merge pull request #1929 from Benjins/patch-2 Update docs link in Cargo.toml to HTTPS version	2022-11-18 18:05:37 -08:00
Benji Smith	de4c551363	Update docs link in Cargo.toml to HTTPS version Currently, the documentation link is specified in Cargo.toml as: documentation = "http://rust-lang.github.io/mdBook/index.html" which propagates to crates.io and if users click on the docs link there they get the non-TLS version. Not likely to cause major issues, but still best practice to use the HTTPS version since it's there	2022-11-18 20:53:08 -05:00
Eric Huss	d45f02d38c	Merge pull request #1924 from averms-forks/html-conformance Better HTML5 conformance	2022-11-13 13:29:18 -08:00
Eric Huss	666975a1ef	Merge pull request #1884 from willcrichton/master Add support for watching additional directories	2022-11-13 12:53:19 -08:00
Will Crichton	144a1e4009	Add documentation for extra-watch-dirs	2022-11-12 14:28:43 -08:00
Will Crichton	8b486dfc71	Fix compilation failure	2022-11-12 14:23:05 -08:00
Aman Verma	db092a404e	State canonical URL using <link> not <meta>. The Google SEO docs describe using the link element to specify the canonical page in a redirect. They don't mention anything about <meta>.	2022-11-12 14:54:28 -06:00
Aman Verma	edda3d1b51	Fix formatting of content attr in <meta http-equiv=refresh> According to the HTML specification[1], there needs to be a space after the semicolon and the URL must be unquoted. [1]: https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-refresh	2022-11-12 14:47:21 -06:00
Aman Verma	27a11e7b35	Don't generate obsolete charset attrs in <script>. According to the HTML specification[1], the charset attribute is obsolete in script elements. [1]: https://html.spec.whatwg.org/multipage/obsolete.html#HTMLScriptElement-partial	2022-11-12 14:45:09 -06:00
Aman Verma	cfd4c93d88	Don't generate redundant <meta http-equiv=content-type>. Quoting from the HTML specification[1]: A document must not contain both a meta element with an http-equiv attribute in the Encoding declaration state and a meta element with the charset attribute present. So we remove the <meta> with the http-equiv attribute from our template. [1]: https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type	2022-11-12 14:27:52 -06:00
Will Crichton	b1ca805d2a	Fix tests	2022-11-07 14:08:31 -08:00
Will Crichton	852a882fab	Improve error handling of extra-watch-dirs watching, fix not watching whitelisted files outside book root	2022-11-07 12:20:59 -08:00
Will Crichton	fb0cbc90e3	Add support for watching additional directories	2022-10-28 11:47:33 -07:00
Dylan DPC	3a24f10d7c	Merge pull request #1911 from yoyomo/fix-copying-invisible-text fix copying invisible text	2022-10-15 11:37:46 +05:30
armandocumate	3fc036e01a	fi xcopying invisible text	2022-10-14 16:53:59 -07:00
Eric Huss	056a46cc97	Merge pull request #1862 from gifnksm/add-musl-binary Deploy {x86_64,aarch64}-unknown-linux-musl binary	2022-10-13 17:17:53 -07:00
Eric Huss	f8df8ed72d	Merge pull request #1906 from brettchalupa/kbd-styles-1813 Add styles for <kbd> elements	2022-10-09 13:52:52 -07:00
Brett Chalupa	79c159d123	Add styles for <kbd> elements Allows for special styles to call them out since they're different than normal text and different than code. They can make use of styles they inherit for font style and weight. Notes on changes: - Added new CSS variables for reused elements - The font-* rules are separate for each aspect so that they can inherit bold/italic/etc Closes https://github.com/rust-lang/mdBook/issues/1813	2022-10-06 16:02:29 -04:00
Dylan DPC	a8c37ceace	Merge pull request #1900 from kianmeng/fix-typos Fix typos	2022-09-29 21:00:10 +05:30
Kian-Meng Ang	cb01f11ad1	Fix typos Found via `codespell -S ./src/theme -L crate,nam,varius,phasis`	2022-09-29 22:41:12 +08:00
Noritada Kobayashi	7aaa84853d	Add test code to show preprocessor developers what the interface data looks like (#1897 ) This test code will show preprocessor developers what the input data looks like and how to test the preprocessing results.	2022-09-24 14:32:41 -07:00
David	75857fbf73	feat: use once_cell instead of lazy_static (#1894 )	2022-09-22 15:05:39 -07:00
Eric Huss	c8db0c8ec6	Merge pull request #1889 from mgeisler/simplify-and-then Simplify the use of `Option::and_then`	2022-09-12 09:16:21 -07:00
Martin Geisler	3958260353	Simplify the use of `Option::and_then` I found a few places where `Option::and_then` could be simplified (in my opinion) with `?` or with `match`.	2022-09-11 00:46:26 +02:00
Eric Huss	8cdb8d0367	Merge pull request #1887 from mgeisler/edition-2021 Require Rust 2021 edition	2022-09-09 13:14:33 -07:00
Dylan DPC	66bf85b14f	Require Rust 2021 edition This allows us to clean up and simplify the code.	2022-09-09 16:00:35 +02:00
Dylan DPC	1a0892745e	Merge pull request #1881 from GuillaumeGomez/unneeded-attribute Remove unneeded `type` attribute for `<script>`	2022-08-30 10:53:11 +05:30
Guillaume Gomez	76b0493fb0	Remove unneeded type attribute for <script>	2022-08-29 21:07:50 +02:00
Chris Lovett	74eb4059d6	add a --chapter option to mdbook test. (#1741 ) Sometimes when working on large books it is handy to be able to run mdbook on a single chapter of a book.	2022-08-25 19:13:51 -07:00
Dylan DPC	13f53eb64f	Merge pull request #1876 from joepio/patch-1 Explain how to use `site-url` with asset URLs	2022-08-23 14:33:02 +05:30
Joep Meindertsma	b3941526cb	Explain how to use `site-url` Make sure people use the right kind of asset-urls. This issue only shows up when deploying, not using `mdbook serve`.	2022-08-23 10:33:25 +02:00
Eric Huss	fff067b2a8	Merge pull request #1836 from mgeisler/trim-trailing-whitespace Avoid empty last line in editable code blocks	2022-08-10 19:55:06 -07:00
Martin Geisler	217546c2a0	Trim trailing whitespace in Rust code blocks Before, a code block would always end with a final newline. The newline was added unconditionally by `hide_lines`. When the code block is syntax highlighted by highlight.js, this is not a problem, no empty line is added for a final trailing `\n` character. However, when the code block is editable and thus handled by the ACE editor, a trailing newline _is_ significant. I believe this issue is most closely described by https://github.com/ajaxorg/ace/issues/2083 in the upstream repository. The effect of the way ACE handles newlines is that a code block like <pre> Some code </pre> will create an editor with _two_ lines, not just one. By trimming trailing whitespace, we ensure that we don’t accidentally create more lines in the ACE editor than necessary.	2022-08-10 03:11:08 +02:00
Eric Huss	40c06f5e77	Merge pull request #1863 from ehuss/bump-version Update to 0.4.21	2022-07-22 11:06:12 -07:00
Eric Huss	bb09caa9a3	Update to 0.4.21	2022-07-22 10:54:53 -07:00
gifnksm	4ebefeb43a	Deploy {x86_64,aarch64}-unknown-linux-musl binary	2022-07-23 00:37:18 +09:00
Eric Huss	8f01d0234f	Merge pull request #1861 from mitchmindtree/nightly-borrowcheck-err-workaround Workaround rust nightly borrowcheck error (#1860)	2022-07-22 07:26:28 -07:00
mitchmindtree	13035baeae	Workaround rust nightly borrowcheck error (#1860 ) Surprisingly, this fixes the error filed at #1860! This seems suspicious, perhaps indicative of a bug in Rust's non-lexical lifetime handling? The lifetimes in the `handlebars::Renderable::render` method signature are quite complicated, and its unclear to me whether or not Rust is catching some new safety edge-case that wasn't previously handled correctly... Possibly related to `drop` order, which I think is related to the order of binding statements?	2022-07-22 15:15:12 +10:00
Eric Huss	92afe9bd3c	Merge pull request #1857 from ehuss/bump-version Update to 0.4.20	2022-07-14 14:26:20 -07:00
Eric Huss	4c1aca0abb	Update to 0.4.20	2022-07-14 13:46:56 -07:00
Eric Huss	da166e051d	Merge pull request #1855 from stevenengler/code-fmt Fix code padding in headings	2022-07-13 18:06:49 -07:00
Steven Engler	6a4ba95926	Fixed code padding in headings	2022-07-13 19:12:33 -04:00
Eric Huss	6688bd8d7b	Merge pull request #1849 from FauconFan/fix_author(s)_in_user_guide authors -> author in user guide	2022-07-09 13:55:51 -07:00
Dylan DPC	01313a39cc	Merge pull request #1851 from FauconFan/revert-1848-remove_non_exhaustive Revert "remove __non_exhaustive members, add non_exhaustive attribute instead"	2022-07-09 21:51:04 +05:30
Joseph Priou	f92911b8aa	Revert "remove __non_exhaustive members, add non_exhaustive attribute instead"	2022-07-09 17:43:17 +02:00
Dylan DPC	42d6fd5804	Merge pull request #1848 from FauconFan/remove_non_exhaustive remove __non_exhaustive members, add non_exhaustive attribute instead	2022-07-09 19:18:25 +05:30
Fauconfan	a8a45a5fbe	authors -> author in user guide	2022-07-09 15:31:00 +02:00
Fauconfan	11781f0c1b	remove __non_exhaustive members, add non_exhaustive attribute instead	2022-07-09 15:05:06 +02:00
Eric Huss	53055e0345	Merge pull request #1840 from ehuss/fix-lock Fix Cargo.lock for version bump.	2022-07-01 15:46:36 -07:00
Eric Huss	1af6d4b0ec	Fix Cargo.lock for version bump.	2022-07-01 15:44:18 -07:00
Eric Huss	3e311dc975	Merge pull request #1838 from ehuss/bump-version Update to 0.4.19	2022-07-01 15:23:01 -07:00
Eric Huss	04e31eb07b	Update to 0.4.19	2022-07-01 14:55:25 -07:00
Eric Huss	eb82ddca0b	Merge pull request #1837 from ehuss/serve-info Always show the "serving on" info for `mdbook serve`.	2022-07-01 14:54:04 -07:00
Eric Huss	1d2b720ebe	Always show the "serving on" info for `mdbook serve`.	2022-07-01 14:36:18 -07:00
Eric Huss	4c303c3b1d	Merge pull request #1830 from ISSOtm/serve Always open index page with `serve --open`	2022-07-01 13:18:47 -07:00
ISSOtm	42129c6181	Always open index page with `serve --open`	2022-07-01 09:01:25 +02:00
Eric Huss	a10a57e67d	Merge pull request #1829 from ISSOtm/index Fix up "index page" functionality	2022-06-29 17:55:11 -07:00
ISSOtm	fa5f32c7fd	Make link to first chapter active in index page Makes both pages more consistent, and also the previous test pass Co-authored-by: Eric Huss <eric@huss.org>	2022-06-29 23:51:18 +02:00
ISSOtm	a91e888575	Add test for index page	2022-06-29 08:48:49 +02:00
ISSOtm	8571883923	Mark the first chapter as "index", even if not the first book item	2022-06-29 08:35:41 +02:00
Eric Huss	4cf005d4bd	Merge pull request #1832 from ISSOtm/clippy Fix Clippy lints	2022-06-27 14:28:39 -07:00
Eric Huss	b38792c166	Merge pull request #1833 from mattheww/2022-06_searchindex Omit words longer than 80 characters from the search index	2022-06-27 14:17:40 -07:00
ISSOtm	248863addf	Fix Clippy lints Also remove `allow(clippy::*)`s where possible	2022-06-27 23:08:45 +02:00
Eric Huss	7e2752e71f	Merge pull request #1834 from ehuss/update-deps Update some dependencies	2022-06-27 13:58:40 -07:00
Eric Huss	cbf0ca027d	Merge pull request #1806 from ehuss/button-overlap Make code buttons appear on hover (or tap on mobile)	2022-06-27 13:58:17 -07:00
Eric Huss	2c2ba636a9	Update pretty_assertions from 0.6.1 to 1.2.1	2022-06-27 13:29:22 -07:00
Eric Huss	494e6722b2	Update env_logger from 0.7.1 to 0.9.0 This drops quick-error 1.2.3 from the tree	2022-06-27 13:29:22 -07:00
Eric Huss	ddf71222c5	Bump tokio from 1.10.0 to 1.16.1	2022-06-27 13:29:18 -07:00
Eric Huss	1d89127d8f	Mention how to uninstall. Closes #1822.	2022-06-27 11:10:09 -07:00
Eric Huss	5f00625c14	Merge pull request #1617 from lf-/x-overflow Fix some x overflows	2022-06-27 11:01:48 -07:00
Matthew Woodcraft	000a93dc77	Test that long words are omitted from the search index. Note they do appear in the 'docs' part of searchindex.json (so they will be visible in search teasers).	2022-06-26 12:22:52 +01:00
Matthew Woodcraft	1f8c090a5f	When creating the search index, omit words longer than 80 characters This avoids creating deeply nested objects in searchindex.json	2022-06-26 12:22:52 +01:00
Eric Huss	0547868d4d	Merge pull request #1825 from joshrotenberg/update-warp-version Update warp to 0.3.2	2022-06-22 17:33:56 -07:00
Dylan DPC	1056b8361c	Merge pull request #1828 from rust-lang/revert-1809-2022-05_searchindex Revert "Omit words longer than 80 characters from the search index"	2022-06-22 13:50:01 +02:00
Dylan DPC	a5f861bf2b	Revert "Omit words longer than 80 characters from the search index"	2022-06-22 13:31:16 +02:00
Dylan DPC	93aee6419e	Merge pull request #1809 from mattheww/2022-05_searchindex Omit words longer than 80 characters from the search index	2022-06-22 13:14:08 +02:00
Josh Rotenberg	4b1a7e9ae7	update warp to 0.3.2	2022-06-20 10:48:03 -07:00
Eric Huss	2f5e89f3ec	Merge pull request #1810 from mattico/el-v3 Update to elasticlunr-rs 3.0.0	2022-06-02 15:02:19 -07:00
Eric Huss	2b903ad057	Make code block icons appear on hover.	2022-06-01 18:48:34 -07:00
Matt Ickstadt	fb397e6fa0	Update to elasticlunr-rs 3.0.0	2022-06-01 20:20:14 -05:00
Matthew Woodcraft	00a55b35a8	Test that long words are omitted from the search index. Note they do appear in the 'docs' part of searchindex.json (so they will be visible in search teasers).	2022-05-22 14:02:54 +01:00
Matthew Woodcraft	d65ce55453	When creating the search index, omit words longer than 80 characters This avoids creating deeply nested objects in searchindex.json	2022-05-22 14:00:20 +01:00
Eric Huss	37d756ae75	Adjust overlap of code buttons with code blocks.	2022-05-16 19:27:46 -07:00
Eric Huss	f8782666ba	Merge pull request #1714 from joshrotenberg/draft-no-index Check for the index.html file before trying to opener::open it	2022-05-16 08:04:38 -07:00
josh rotenberg	c74c682939	call find_chapter when opening browser	2022-05-11 13:14:38 -07:00
josh rotenberg	8b49600673	call first_chapter	2022-05-10 11:19:23 -07:00
josh rotenberg	29c729fd23	call first_chapter	2022-05-10 11:17:20 -07:00
josh rotenberg	5d65967448	add first_chapter function	2022-05-10 11:16:22 -07:00
Eric Huss	bf258eeb9b	Merge pull request #1801 from klensy/static-regex init regexes via lazy_static	2022-05-06 12:05:10 -07:00
klensy	af6237015a	init regexes via lazy_static, don't recompute it	2022-05-06 10:05:52 +03:00
Eric Huss	a462fb63c3	Merge pull request #1798 from klensy/serde_derive Use serde's `derive` feature instead of directly importing serde_derive	2022-05-05 12:55:01 -07:00
klensy	f3332fb0da	Use serde's `derive` feature instead of directly importing serde_derive	2022-05-05 09:33:51 +03:00
Eric Huss	5bea83114b	Merge pull request #1791 from clarkfw/master bail! in render() if specified theme directory does not exist	2022-05-02 11:08:57 -07:00
Clark	fe8bb38ec1	add a test: Ensure building fails if `[output.html].theme` points to a non-existent directory	2022-04-28 13:13:58 +08:00
Clark	a60571321a	bail! in render() if specified theme directory does not exist	2022-04-26 20:20:44 +08:00
Eric Huss	e1c2e1a753	Merge pull request #1788 from max-sixty/patch-1 Fix typo in changelog	2022-04-15 12:26:42 -07:00
Maximilian Roos	800dbf2929	Fix typo in changelog	2022-04-15 12:09:31 -07:00
Eric Huss	1880447dce	Merge pull request #1787 from ehuss/bump-version Update to 0.4.18	2022-04-15 11:33:56 -07:00
Eric Huss	268dbb099f	Update to 0.4.18	2022-04-15 11:24:45 -07:00
Eric Huss	ae275ad1b1	Merge pull request #1785 from ehuss/summary-escape Don't try to render summary links as markdown.	2022-04-15 11:20:17 -07:00
Eric Huss	ceff050bb4	Don't try to render summary links as markdown.	2022-04-14 20:35:39 -07:00
josh rotenberg	8357811d96	Merge branch 'draft-no-index' of https://github.com/joshrotenberg/mdBook into draft-no-index	2022-04-04 18:59:47 -07:00
josh rotenberg	860a17d85a	Merge branch 'rust-lang:master' into draft-no-index	2022-04-04 18:59:39 -07:00
Eric Huss	ba324cddb6	Merge pull request #1778 from sgoudham/fix-typo User Guide: Fix typo 'mbdook' to 'mdbook'	2022-04-01 14:36:51 -07:00
Eric Huss	a5dcd78393	Merge pull request #1777 from trofi/ignore-RUST_LOG tests/cli: ignore user's RUST_LOG= environment variable in tests	2022-04-01 14:00:44 -07:00
sgoudham	8e1195322a	Fix typo 'mbdook' to 'mdbook'	2022-04-01 13:13:58 +01:00
Sergei Trofimovich	2a2b51c8ab	tests/cli: ignore user's RUST_LOG= environment variable in tests nixpkgs build system sets `RUST_LOG=` (empty value) by default. This switches `mdBook` into warnings+ mode (instead of info+). This causes the following tests to fail: $ RUST_LOG= cargo test --test cli_tests ... cli::test::mdbook_cli_can_correctly_test_a_passing_book cli::test::mdbook_cli_detects_book_with_failing_tests cli::build::mdbook_cli_dummy_book_generates_index_html The change drops RUST_LOG= entry.	2022-04-01 08:15:18 +01:00
Jade Lovelace	4ae7ab5e87	switch to break-word as suggested	2022-01-27 18:42:39 -08:00
Jade	59569984e2	Address review: use overflow-wrap everywhere	2022-01-27 18:41:31 -08:00
Jade	89b580ab52	Add a test for the table div-wrapping	2022-01-27 18:41:31 -08:00
Jade	85df785cd3	Wrap tables in an overflow-x wrapper div	2022-01-27 18:41:30 -08:00
Jade	fde88c22a8	Fix an x overflow with long inline code Spotted on https://rust-lang.github.io/rfcs/2603-rust-symbol-name-mangling-v0.html	2022-01-27 18:39:09 -08:00
josh rotenberg	f5b0b1934a	Merge remote-tracking branch 'upstream/master' into draft-no-index	2022-01-11 09:53:43 -08:00
josh rotenberg	1cacef025d	check for the index.html file first	2021-12-28 21:00:06 -08:00