Merge pull request #2206 from ehuss/bump-version

Update to 0.4.35
2025-12-28 15:01:45 -05:00 · 2023-09-29 22:43:05 +00:00 · 2023-09-29 14:33:45 -07:00 · 2023-09-29 14:33:20 -07:00 · 2023-09-22 17:26:27 +00:00 · 2023-09-19 20:44:39 +06:00
26 changed files with 911 additions and 452 deletions
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -3,6 +3,13 @@ on:
  release:
    types: [created]

+defaults:
+  run:
+    shell: bash
+
+permissions:
+  contents: write
+
 jobs:
  release:
    name: Deploy Release
@@ -28,17 +35,14 @@ jobs:
            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 ${{ matrix.target }}
-      shell: bash
-    - name: Build and deploy artifacts
+    - name: Build asset
+      run: ci/make-release-asset.sh ${{ matrix.os }} ${{ matrix.target }}
+    - name: Update release with new asset
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: ci/make-release.sh ${{ matrix.os }} ${{ matrix.target }}
-      shell: bash
+      run: gh release upload $MDBOOK_TAG $MDBOOK_ASSET
  pages:
    name: GitHub Pages
    runs-on: ubuntu-latest
@@ -56,3 +60,14 @@ jobs:
        curl -LsSf https://raw.githubusercontent.com/rust-lang/simpleinfra/master/setup-deploy-keys/src/deploy.rs | rustc - -o /tmp/deploy
        cd guide/book
        /tmp/deploy
+  publish:
+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Install Rust (rustup)
+        run: rustup update stable --no-self-update && rustup default stable
+      - name: Publish
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        run: cargo publish --no-verify
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -1,10 +1,7 @@
 name: CI
 on:
-  # Only run when merging to master, or open/synchronize/reopen a PR.
-  push:
-    branches:
-      - master
  pull_request:
+  merge_group:

 jobs:
  test:
@@ -32,7 +29,7 @@ jobs:
          - build: msrv
            os: ubuntu-20.04
            # sync MSRV with docs: guide/src/guide/installation.md and Cargo.toml
-            rust: 1.65.0
+            rust: 1.66.0
    steps:
    - uses: actions/checkout@v3
    - name: Install Rust
@@ -50,3 +47,20 @@ jobs:
    - name: Install Rust
      run: rustup update stable && rustup default stable && rustup component add rustfmt
    - run: cargo fmt --check
+
+  # The success job is here to consolidate the total success/failure state of
+  # all other jobs. This job is then included in the GitHub branch protection
+  # rule which prevents merges unless all other jobs are passing. This makes
+  # it easier to manage the list of jobs via this yml file and to prevent
+  # accidentally adding new jobs without also updating the branch protections.
+  success:
+    name: Success gate
+    if: always()
+    needs:
+      - test
+      - rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'
+      - name: Done
+        run: exit 0
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,60 @@
 # Changelog

+## mdBook 0.4.35
+[v0.4.34...v0.4.35](https://github.com/rust-lang/mdBook/compare/v0.4.34...v0.4.35)
+
+### Added
+- Added the `book.text-direction` setting for explicit support for right-to-left languages.
+  [#1641](https://github.com/rust-lang/mdBook/pull/1641)
+- Added `rel=prefetch` to the "next" links to potentially improve browser performance.
+  [#2168](https://github.com/rust-lang/mdBook/pull/2168)
+- Added a `.warning` CSS class which is styled for displaying warning blocks.
+  [#2187](https://github.com/rust-lang/mdBook/pull/2187)
+
+### Changed
+- Better support of the sidebar when JavaScript is disabled.
+  [#2175](https://github.com/rust-lang/mdBook/pull/2175)
+
+## mdBook 0.4.34
+[v0.4.33...v0.4.34](https://github.com/rust-lang/mdBook/compare/v0.4.33...v0.4.34)
+
+### Fixed
+- Fixed file change watcher failing on macOS with a large number of files.
+  [#2157](https://github.com/rust-lang/mdBook/pull/2157)
+
+## mdBook 0.4.33
+[v0.4.32...v0.4.33](https://github.com/rust-lang/mdBook/compare/v0.4.32...v0.4.33)
+
+### Added
+- The `color-scheme` CSS property is now set based on the light/dark theme, which applies some slight color differences in browser elements like scroll bars on some browsers.
+  [#2134](https://github.com/rust-lang/mdBook/pull/2134)
+
+### Fixed
+- Fixed watching of extra-watch-dirs when not running in the book root directory.
+  [#2146](https://github.com/rust-lang/mdBook/pull/2146)
+- Reverted the dependency update to the `toml` crate (again!). This was an unintentional breaking change in 0.4.32.
+  [#2021](https://github.com/rust-lang/mdBook/pull/2021)
+- Changed macOS change notifications to use the kqueue implementation which should fix some issues with repeated rebuilds when a file changed.
+  [#2152](https://github.com/rust-lang/mdBook/pull/2152)
+- Don't set a background color in the print page for code blocks in a header.
+  [#2150](https://github.com/rust-lang/mdBook/pull/2150)
+
+## mdBook 0.4.32
+[v0.4.31...v0.4.32](https://github.com/rust-lang/mdBook/compare/v0.4.31...v0.4.32)
+
+### Fixed
+- Fixed theme-color meta tag not syncing with the theme.
+  [#2118](https://github.com/rust-lang/mdBook/pull/2118)
+
+### Changed
+- Updated all dependencies.
+  [#2121](https://github.com/rust-lang/mdBook/pull/2121)
+  [#2122](https://github.com/rust-lang/mdBook/pull/2122)
+  [#2123](https://github.com/rust-lang/mdBook/pull/2123)
+  [#2124](https://github.com/rust-lang/mdBook/pull/2124)
+  [#2125](https://github.com/rust-lang/mdBook/pull/2125)
+  [#2126](https://github.com/rust-lang/mdBook/pull/2126)
+
 ## mdBook 0.4.31
 [v0.4.30...v0.4.31](https://github.com/rust-lang/mdBook/compare/v0.4.30...v0.4.31)

@@ -224,7 +279,7 @@
  [#1771](https://github.com/rust-lang/mdBook/pull/1771)
 - The 404 not-found page now includes the books title in the HTML title tag.
  [#1693](https://github.com/rust-lang/mdBook/pull/1693)
- Migrated to clap 3.0 which which handles CLI option parsing.
+- Migrated to clap 3.0 which handles CLI option parsing.
  [#1731](https://github.com/rust-lang/mdBook/pull/1731)

 ### Fixed
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -153,3 +153,23 @@ The following are instructions for updating [highlight.js](https://highlightjs.o
 1. Copy `build/highlight.min.js` to mdbook's directory [`highlight.js`](https://github.com/rust-lang/mdBook/blob/master/src/theme/highlight.js).
 1. Be sure to check the highlight.js [CHANGES](https://github.com/highlightjs/highlight.js/blob/main/CHANGES.md) for any breaking changes. Breaking changes that would affect users will need to wait until the next major release.
 1. Build mdbook with the new file and build some books with the new version and compare the output with a variety of languages to see if anything changes. The [test_book](https://github.com/rust-lang/mdBook/tree/master/test_book) contains a chapter with many languages to examine.
+
+## Publishing new releases
+
+Instructions for mdBook maintainers to publish a new release:
+
+1. Create a PR to update the version and update the CHANGELOG:
+    1. Update the version in `Cargo.toml`
+    2. Run `cargo test` to verify that everything is passing, and to update `Cargo.lock`.
+    3. Double-check for any SemVer breaking changes.
+       Try [`cargo-semver-checks`](https://crates.io/crates/cargo-semver-checks), though beware that the current version of mdBook isn't properly adhering to SemVer due to the lack of `#[non_exhaustive]` and other issues. See https://github.com/rust-lang/mdBook/issues/1835.
+    4. Update `CHANGELOG.md` with any changes that users may be interested in.
+    5. Update `continuous-integration.md` to update the version number for the installation instructions.
+    6. Commit the changes, and open a PR.
+2. After the PR has been merged, create a release in GitHub. This can either be done in the GitHub web UI, or on the command-line:
+   ```bash
+   MDBOOK_VERS="`cargo read-manifest | jq -r .version`" ; \
+    gh release create -R rust-lang/mdbook v$MDBOOK_VERS \
+        --title v$MDBOOK_VERS \
+        --notes "See https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-${MDBOOK_VERS//.} for a complete list of changes."
+   ```
--- a/Cargo.lock
+++ b/Cargo.lock
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mdbook"
-version = "0.4.31"
+version = "0.4.35"
 authors = [
    "Mathieu David <mathieudavid@mathieudavid.org>",
    "Michael-F-Bryan <michaelfbryan@gmail.com>",
@@ -14,31 +14,31 @@ license = "MPL-2.0"
 readme = "README.md"
 repository = "https://github.com/rust-lang/mdBook"
 description = "Creates a book from markdown files"
-rust-version = "1.65"
+rust-version = "1.66"

 [dependencies]
 anyhow = "1.0.71"
 chrono = { version = "0.4.24", default-features = false, features = ["clock"] }
-clap = { version = "4.2.7", features = ["cargo", "wrap_help"] }
-clap_complete = "4.2.3"
+clap = { version = "4.3.12", features = ["cargo", "wrap_help"] }
+clap_complete = "4.3.2"
 once_cell = "1.17.1"
 env_logger = "0.10.0"
 handlebars = "4.3.7"
 log = "0.4.17"
 memchr = "2.5.0"
-opener = "0.5.2"
+opener = "0.6.1"
 pulldown-cmark = { version = "0.9.3", default-features = false }
 regex = "1.8.1"
 serde = { version = "1.0.163", features = ["derive"] }
 serde_json = "1.0.96"
 shlex = "1.1.0"
 tempfile = "3.4.0"
-toml = "0.5.11"
+toml = "0.5.11" # Do not update, see https://github.com/rust-lang/mdBook/issues/2037
 topological-sort = "0.2.2"

 # Watch feature
-notify = { version = "5.1.0", optional = true }
-notify-debouncer-mini = { version = "0.2.1", optional = true }
+notify = { version = "6.0.1", optional = true }
+notify-debouncer-mini = { version = "0.3.0", optional = true }
 ignore = { version = "0.4.20", optional = true }

 # Serve feature
@@ -52,7 +52,7 @@ ammonia = { version = "3.3.0", optional = true }

 [dev-dependencies]
 assert_cmd = "2.0.11"
-predicates = "2.1.5"
+predicates = "3.0.3"
 select = "0.6.0"
 semver = "1.0.17"
 pretty_assertions = "1.3.0"
--- a/ci/install-hub.sh
+++ b/ci/install-hub.sh
@@ -1,24 +0,0 @@
-#!/usr/bin/env bash
-# Installs the `hub` executable into hub/bin
-set -ex
-case $1 in
-  ubuntu*)
-    curl -LsSf https://github.com/github/hub/releases/download/v2.12.8/hub-linux-amd64-2.12.8.tgz -o hub.tgz
-    mkdir hub
-    tar -xzvf hub.tgz --strip=1 -C hub
-    ;;
-  macos*)
-    curl -LsSf https://github.com/github/hub/releases/download/v2.12.8/hub-darwin-amd64-2.12.8.tgz -o hub.tgz
-    mkdir hub
-    tar -xzvf hub.tgz --strip=1 -C hub
-    ;;
-  windows*)
-    curl -LsSf https://github.com/github/hub/releases/download/v2.12.8/hub-windows-amd64-2.12.8.zip -o hub.zip
-    7z x hub.zip -ohub
-    ;;
-  *)
-    echo "OS should be first parameter, was: $1"
-    ;;
-esac
-
-echo "$PWD/hub/bin" >> $GITHUB_PATH
--- a/ci/make-release-asset.sh
+++ b/ci/make-release-asset.sh
@@ -44,9 +44,10 @@ case $1 in
 esac
 cd ../..

-if [[ -z "$GITHUB_TOKEN" ]]
+if [[ -z "$GITHUB_ENV" ]]
 then
-  echo "$GITHUB_TOKEN not set, skipping deploy."
+  echo "GITHUB_ENV not set, run: gh release upload $TAG target/$asset"
 else
-  hub release edit -m "" --attach $asset $TAG
+  echo "MDBOOK_TAG=$TAG" >> $GITHUB_ENV
+  echo "MDBOOK_ASSET=target/$asset" >> $GITHUB_ENV
 fi
--- a/guide/src/cli/completions.md
+++ b/guide/src/cli/completions.md
@@ -6,7 +6,11 @@ This means when you type `mdbook` in your shell, you can then press your shell's
 The completions first need to be installed for your shell:

 ```bash
+# bash
 mdbook completions bash > ~/.local/share/bash-completion/completions/mdbook
+# oh-my-zsh
+mdbook completions zsh > ~/.oh-my-zsh/completions/_mdbook
+autoload -U compinit && compinit
 ```

 The command prints a completion script for the given shell.
--- a/guide/src/cli/test.md
+++ b/guide/src/cli/test.md
@@ -6,8 +6,7 @@ of code examples that could get outdated. Therefore it is very important for
 them to be able to automatically test these code examples.

 mdBook supports a `test` command that will run all available tests in a book. At
-the moment, only rustdoc tests are supported, but this may be expanded upon in
-the future.
+the moment, only Rust tests are supported.

 #### Disable tests on a code block

@@ -65,4 +64,4 @@ not specified it will default to the value of the `build.build-dir` key in
 #### --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.
+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.31/mdbook-v0.4.31-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin
+curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.35/mdbook-v0.4.35-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
@@ -46,6 +46,9 @@ This is general information about your book.
  `src` directly under the root folder. But this is configurable with the `src`
  key in the configuration file.
 - **language:** The main language of the book, which is used as a language attribute `<html lang="en">` for example.
+  This is also used to derive the direction of text (RTL, LTR) within the book.
+- **text-direction**: The direction of text in the book: Left-to-right (LTR) or Right-to-left (RTL). Possible values: `ltr`, `rtl`.
+  When not specified, the text direction is derived from the book's `language` attribute.

 **book.toml**
 ```toml
@@ -55,6 +58,7 @@ authors = ["John Doe", "Jane Doe"]
 description = "The example book covers examples."
 src = "my-src"  # the source files will be found in `root/my-src` instead of `root/src`
 language = "en"
+text-direction = "ltr"
 ```

 ### Rust options
@@ -97,7 +101,7 @@ extra-watch-dirs = []             # directories to watch for triggering builds
  will be created when the book is built (i.e. `create-missing = true`). If this
  is `false` then the build process will instead exit with an error if any files
  do not exist.
- **use-default-preprocessors:** Disable the default preprocessors of (`links` &
+- **use-default-preprocessors:** Disable the default preprocessors (of `links` &
  `index`) by setting this option to `false`.

  If you have the same, and/or other preprocessors declared via their table
@@ -111,4 +115,4 @@ extra-watch-dirs = []             # directories to watch for triggering builds
    `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.
+  trigger rebuilds. Useful if your book depends on files outside its `src` directory.
--- a/guide/src/format/markdown.md
+++ b/guide/src/format/markdown.md
@@ -73,14 +73,14 @@ Linking to a URL or local file is easy:
 ```markdown
 Use [mdBook](https://github.com/rust-lang/mdBook). 

-Read about [mdBook](mdBook.md).
+Read about [mdBook](mdbook.md).

 A bare url: <https://www.rust-lang.org>.
 ```

 Use [mdBook](https://github.com/rust-lang/mdBook). 

-Read about [mdBook](mdBook.md).
+Read about [mdBook](mdbook.md).

 A bare url: <https://www.rust-lang.org>.

--- a/guide/src/format/mdbook.md
+++ b/guide/src/format/mdbook.md
@@ -314,3 +314,51 @@ contents (sidebar) by including a `\{{#title ...}}` near the top of the page.
 ```hbs
 \{{#title My Title}}
 ```
+
+## HTML classes provided by mdBook
+
+<img class="right" src="images/rust-logo-blk.svg" alt="The Rust logo">
+
+### `class="left"` and `"right"`
+
+These classes are provided by default, for inline HTML to float images.
+
+```html
+<img class="right" src="images/rust-logo-blk.svg" alt="The Rust logo">
+```
+
+### `class="hidden"`
+
+HTML tags with class `hidden` will not be shown.
+
+```html
+<div class="hidden">This will not be seen.</div>
+```
+
+<div class="hidden">This will not be seen.</div>
+
+### `class="warning"`
+
+To make a warning or similar note stand out, wrap it in a warning div.
+
+```html
+<div class="warning">
+
+This is a bad thing that you should pay attention to.
+
+Warning blocks should be used sparingly in documentation, to avoid "warning
+fatique," where people are trained to ignore them because they usually don't
+matter for what they're doing.
+
+</div>
+```
+
+<div class="warning">
+
+This is a bad thing that you should pay attention to.
+
+Warning blocks should be used sparingly in documentation, to avoid "warning
+fatique," where people are trained to ignore them because they usually don't
+matter for what they're doing.
+
+</div>
--- a/guide/src/guide/installation.md
+++ b/guide/src/guide/installation.md
@@ -20,7 +20,7 @@ To make it easier to run, put the path to the binary into your `PATH`.

 To build the `mdbook` executable from source, you will first need to install Rust and Cargo.
 Follow the instructions on the [Rust installation page].
-mdBook currently requires at least Rust version 1.65.
+mdBook currently requires at least Rust version 1.66.

 Once you have installed Rust, the following command can be used to build and install mdBook:

--- a/src/cmd/watch.rs
+++ b/src/cmd/watch.rs
@@ -130,11 +130,16 @@ where
    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) {
+        let path = book.root.join(dir);
+        let canonical_path = path.canonicalize().unwrap_or_else(|e| {
+            error!("Error while watching extra directory {path:?}:\n    {e}");
+            std::process::exit(1);
+        });
+
+        if let Err(e) = watcher.watch(&canonical_path, Recursive) {
            error!(
                "Error while watching extra directory {:?}:\n    {:?}",
-                path, e
+                canonical_path, e
            );
            std::process::exit(1);
        }
--- a/src/config.rs
+++ b/src/config.rs
@@ -411,6 +411,9 @@ pub struct BookConfig {
    pub multilingual: bool,
    /// The main language of the book.
    pub language: Option<String>,
+    /// The direction of text in the book: Left-to-right (LTR) or Right-to-left (RTL).
+    /// When not specified, the text direction is derived from [`BookConfig::language`].
+    pub text_direction: Option<TextDirection>,
 }

 impl Default for BookConfig {
@@ -422,6 +425,43 @@ impl Default for BookConfig {
            src: PathBuf::from("src"),
            multilingual: false,
            language: Some(String::from("en")),
+            text_direction: None,
+        }
+    }
+}
+
+impl BookConfig {
+    /// Gets the realized text direction, either from [`BookConfig::text_direction`]
+    /// or derived from [`BookConfig::language`], to be used by templating engines.
+    pub fn realized_text_direction(&self) -> TextDirection {
+        if let Some(direction) = self.text_direction {
+            direction
+        } else {
+            TextDirection::from_lang_code(self.language.as_deref().unwrap_or_default())
+        }
+    }
+}
+
+/// Text direction to use for HTML output
+#[derive(Debug, Copy, Clone, PartialEq, Serialize, Deserialize)]
+pub enum TextDirection {
+    /// Left to right.
+    #[serde(rename = "ltr")]
+    LeftToRight,
+    /// Right to left
+    #[serde(rename = "rtl")]
+    RightToLeft,
+}
+
+impl TextDirection {
+    /// Gets the text direction from language code
+    pub fn from_lang_code(code: &str) -> Self {
+        match code {
+            // list sourced from here: https://github.com/abarrak/rtl/blob/master/lib/rtl/core.rb#L16
+            "ar" | "ara" | "arc" | "ae" | "ave" | "egy" | "he" | "heb" | "nqo" | "pal" | "phn"
+            | "sam" | "syc" | "syr" | "fa" | "per" | "fas" | "ku" | "kur" | "ur" | "urd"
+            | "pus" | "ps" | "yi" | "yid" => TextDirection::RightToLeft,
+            _ => TextDirection::LeftToRight,
        }
    }
 }
@@ -788,6 +828,7 @@ mod tests {
            multilingual: true,
            src: PathBuf::from("source"),
            language: Some(String::from("ja")),
+            text_direction: None,
        };
        let build_should_be = BuildConfig {
            build_dir: PathBuf::from("outputs"),
@@ -1140,6 +1181,73 @@ mod tests {
        assert_eq!(&get_404_output_file(&html_config.input_404), "missing.html");
    }

+    #[test]
+    fn text_direction_ltr() {
+        let src = r#"
+        [book]
+        text-direction = "ltr"
+        "#;
+
+        let got = Config::from_str(src).unwrap();
+        assert_eq!(got.book.text_direction, Some(TextDirection::LeftToRight));
+    }
+
+    #[test]
+    fn text_direction_rtl() {
+        let src = r#"
+        [book]
+        text-direction = "rtl"
+        "#;
+
+        let got = Config::from_str(src).unwrap();
+        assert_eq!(got.book.text_direction, Some(TextDirection::RightToLeft));
+    }
+
+    #[test]
+    fn text_direction_none() {
+        let src = r#"
+        [book]
+        "#;
+
+        let got = Config::from_str(src).unwrap();
+        assert_eq!(got.book.text_direction, None);
+    }
+
+    #[test]
+    fn test_text_direction() {
+        let mut cfg = BookConfig::default();
+
+        // test deriving the text direction from language codes
+        cfg.language = Some("ar".into());
+        assert_eq!(cfg.realized_text_direction(), TextDirection::RightToLeft);
+
+        cfg.language = Some("he".into());
+        assert_eq!(cfg.realized_text_direction(), TextDirection::RightToLeft);
+
+        cfg.language = Some("en".into());
+        assert_eq!(cfg.realized_text_direction(), TextDirection::LeftToRight);
+
+        cfg.language = Some("ja".into());
+        assert_eq!(cfg.realized_text_direction(), TextDirection::LeftToRight);
+
+        // test forced direction
+        cfg.language = Some("ar".into());
+        cfg.text_direction = Some(TextDirection::LeftToRight);
+        assert_eq!(cfg.realized_text_direction(), TextDirection::LeftToRight);
+
+        cfg.language = Some("ar".into());
+        cfg.text_direction = Some(TextDirection::RightToLeft);
+        assert_eq!(cfg.realized_text_direction(), TextDirection::RightToLeft);
+
+        cfg.language = Some("en".into());
+        cfg.text_direction = Some(TextDirection::LeftToRight);
+        assert_eq!(cfg.realized_text_direction(), TextDirection::LeftToRight);
+
+        cfg.language = Some("en".into());
+        cfg.text_direction = Some(TextDirection::RightToLeft);
+        assert_eq!(cfg.realized_text_direction(), TextDirection::RightToLeft);
+    }
+
    #[test]
    #[should_panic(expected = "Invalid configuration file")]
    fn invalid_language_type_error() {
--- a/src/renderer/html_handlebars/hbs_renderer.rs
+++ b/src/renderer/html_handlebars/hbs_renderer.rs
@@ -648,6 +648,10 @@ fn make_data(
        "language".to_owned(),
        json!(config.book.language.clone().unwrap_or_default()),
    );
+    data.insert(
+        "text_direction".to_owned(),
+        json!(config.book.realized_text_direction()),
+    );
    data.insert(
        "book_title".to_owned(),
        json!(config.book.title.clone().unwrap_or_default()),
@@ -1088,6 +1092,8 @@ struct RenderItemContext<'a> {

 #[cfg(test)]
 mod tests {
+    use crate::config::TextDirection;
+
    use super::*;
    use pretty_assertions::assert_eq;

@@ -1299,4 +1305,10 @@ mod tests {
            assert_eq!(&*got, *should_be);
        }
    }
+
+    #[test]
+    fn test_json_direction() {
+        assert_eq!(json!(TextDirection::RightToLeft), json!("rtl"));
+        assert_eq!(json!(TextDirection::LeftToRight), json!("ltr"));
+    }
 }
--- a/src/theme/book.js
+++ b/src/theme/book.js
@@ -346,7 +346,7 @@ function playground_text(playground, hidden = true) {
        }

        setTimeout(function () {
-            themeColorMetaTag.content = getComputedStyle(document.body).backgroundColor;
+            themeColorMetaTag.content = getComputedStyle(document.documentElement).backgroundColor;
        }, 1);

        if (window.ace && window.editors) {
@@ -441,7 +441,7 @@ function playground_text(playground, hidden = true) {
 })();

 (function sidebar() {
-    var html = document.querySelector("html");
+    var body = document.querySelector("body");
    var sidebar = document.getElementById("sidebar");
    var sidebarLinks = document.querySelectorAll('#sidebar a');
    var sidebarToggleButton = document.getElementById("sidebar-toggle");
@@ -449,8 +449,8 @@ function playground_text(playground, hidden = true) {
    var firstContact = null;

    function showSidebar() {
-        html.classList.remove('sidebar-hidden')
-        html.classList.add('sidebar-visible');
+        body.classList.remove('sidebar-hidden')
+        body.classList.add('sidebar-visible');
        Array.from(sidebarLinks).forEach(function (link) {
            link.setAttribute('tabIndex', 0);
        });
@@ -471,8 +471,8 @@ function playground_text(playground, hidden = true) {
    });

    function hideSidebar() {
-        html.classList.remove('sidebar-visible')
-        html.classList.add('sidebar-hidden');
+        body.classList.remove('sidebar-visible')
+        body.classList.add('sidebar-hidden');
        Array.from(sidebarLinks).forEach(function (link) {
            link.setAttribute('tabIndex', -1);
        });
@@ -483,14 +483,14 @@ function playground_text(playground, hidden = true) {

    // Toggle sidebar
    sidebarToggleButton.addEventListener('click', function sidebarToggle() {
-        if (html.classList.contains("sidebar-hidden")) {
+        if (body.classList.contains("sidebar-hidden")) {
            var current_width = parseInt(
                document.documentElement.style.getPropertyValue('--sidebar-width'), 10);
            if (current_width < 150) {
                document.documentElement.style.setProperty('--sidebar-width', '150px');
            }
            showSidebar();
-        } else if (html.classList.contains("sidebar-visible")) {
+        } else if (body.classList.contains("sidebar-visible")) {
            hideSidebar();
        } else {
            if (getComputedStyle(sidebar)['transform'] === 'none') {
@@ -506,14 +506,14 @@ function playground_text(playground, hidden = true) {
    function initResize(e) {
        window.addEventListener('mousemove', resize, false);
        window.addEventListener('mouseup', stopResize, false);
-        html.classList.add('sidebar-resizing');
+        body.classList.add('sidebar-resizing');
    }
    function resize(e) {
        var pos = (e.clientX - sidebar.offsetLeft);
        if (pos < 20) {
            hideSidebar();
        } else {
-            if (html.classList.contains("sidebar-hidden")) {
+            if (body.classList.contains("sidebar-hidden")) {
                showSidebar();
            }
            pos = Math.min(pos, window.innerWidth - 100);
@@ -522,7 +522,7 @@ function playground_text(playground, hidden = true) {
    }
    //on mouseup remove windows functions mousemove & mouseup
    function stopResize(e) {
-        html.classList.remove('sidebar-resizing');
+        body.classList.remove('sidebar-resizing');
        window.removeEventListener('mousemove', resize, false);
        window.removeEventListener('mouseup', stopResize, false);
    }
@@ -557,20 +557,35 @@ function playground_text(playground, hidden = true) {
    document.addEventListener('keydown', function (e) {
        if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
        if (window.search && window.search.hasFocus()) { return; }
+        var html = document.querySelector('html');

+        function next() {
+            var nextButton = document.querySelector('.nav-chapters.next');
+            if (nextButton) {
+                window.location.href = nextButton.href;
+            }
+        }
+        function prev() {
+            var previousButton = document.querySelector('.nav-chapters.previous');
+            if (previousButton) {
+                window.location.href = previousButton.href;
+            }
+        }
        switch (e.key) {
            case 'ArrowRight':
                e.preventDefault();
-                var nextButton = document.querySelector('.nav-chapters.next');
-                if (nextButton) {
-                    window.location.href = nextButton.href;
+                if (html.dir == 'rtl') {
+                    prev();
+                } else {
+                    next();
                }
                break;
            case 'ArrowLeft':
                e.preventDefault();
-                var previousButton = document.querySelector('.nav-chapters.previous');
-                if (previousButton) {
-                    window.location.href = previousButton.href;
+                if (html.dir == 'rtl') {
+                    next();
+                } else {
+                    prev();
                }
                break;
        }
--- a/src/theme/css/chrome.css
+++ b/src/theme/css/chrome.css
@@ -37,9 +37,9 @@ a > .hljs {
    display: flex;
    flex-wrap: wrap;
    background-color: var(--bg);
-    border-bottom-color: var(--bg);
-    border-bottom-width: 1px;
-    border-bottom-style: solid;
+    border-block-end-color: var(--bg);
+    border-block-end-width: 1px;
+    border-block-end-style: solid;
 }
 #menu-bar.sticky,
 .js #menu-bar-hover-placeholder:hover + #menu-bar,
@@ -56,7 +56,7 @@ a > .hljs {
    height: var(--menu-bar-height);
 }
 #menu-bar.bordered {
-    border-bottom-color: var(--table-border-color);
+    border-block-end-color: var(--table-border-color);
 }
 #menu-bar i, #menu-bar .icon-button {
    position: relative;
@@ -93,7 +93,7 @@ a > .hljs {
    display: flex;
    margin: 0 5px;
 }
-.no-js .left-buttons {
+.no-js .left-buttons button {
    display: none;
 }

@@ -160,7 +160,7 @@ a > .hljs {
 }

 .nav-wrapper {
-    margin-top: 50px;
+    margin-block-start: 50px;
    display: none;
 }

@@ -173,23 +173,34 @@ a > .hljs {
    background-color: var(--sidebar-bg);
 }

-.previous {
-    float: left;
-}
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }

+/* Only Firefox supports flow-relative values */
 .next {
    float: right;
    right: var(--page-padding);
 }
+[dir=rtl] .next {
+    float: left;
+    right: unset;
+    left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }

@media only screen and (max-width: 1080px) {
    .nav-wide-wrapper { display: none; }
    .nav-wrapper { display: block; }
 }

+/* sidebar-visible */
@media only screen and (max-width: 1380px) {
-    .sidebar-visible .nav-wide-wrapper { display: none; }
-    .sidebar-visible .nav-wrapper { display: block; }
+    #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+    #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
 }

 /* Inline code */
@@ -236,7 +247,7 @@ pre > .buttons :hover {
    background-color: var(--theme-hover);
 }
 pre > .buttons i {
-    margin-left: 8px;
+    margin-inline-start: 8px;
 }
 pre > .buttons button {
    cursor: inherit;
@@ -273,7 +284,7 @@ pre > code {
 }

 pre > .result {
-    margin-top: 10px;
+    margin-block-start: 10px;
 }

 /* Search */
@@ -284,8 +295,14 @@ pre > .result {

 mark {
    border-radius: 2px;
-    padding: 0 3px 1px 3px;
-    margin: 0 -3px -1px -3px;
+    padding-block-start: 0;
+    padding-block-end: 1px;
+    padding-inline-start: 3px;
+    padding-inline-end: 3px;
+    margin-block-start: 0;
+    margin-block-end: -1px;
+    margin-inline-start: -3px;
+    margin-inline-end: -3px;
    background-color: var(--search-mark-bg);
    transition: background-color 300ms linear;
    cursor: pointer;
@@ -297,14 +314,17 @@ mark.fade-out {
 }

 .searchbar-outer {
-    margin-left: auto;
-    margin-right: auto;
+    margin-inline-start: auto;
+    margin-inline-end: auto;
    max-width: var(--content-max-width);
 }

 #searchbar {
    width: 100%;
-    margin: 5px auto 0px auto;
+    margin-block-start: 5px;
+    margin-block-end: 0;
+    margin-inline-start: auto;
+    margin-inline-end: auto;
    padding: 10px 16px;
    transition: box-shadow 300ms ease-in-out;
    border: 1px solid var(--searchbar-border-color);
@@ -320,20 +340,23 @@ mark.fade-out {
 .searchresults-header {
    font-weight: bold;
    font-size: 1em;
-    padding: 18px 0 0 5px;
+    padding-block-start: 18px;
+    padding-block-end: 0;
+    padding-inline-start: 5px;
+    padding-inline-end: 0;
    color: var(--searchresults-header-fg);
 }

 .searchresults-outer {
-    margin-left: auto;
-    margin-right: auto;
+    margin-inline-start: auto;
+    margin-inline-end: auto;
    max-width: var(--content-max-width);
-    border-bottom: 1px dashed var(--searchresults-border-color);
+    border-block-end: 1px dashed var(--searchresults-border-color);
 }

 ul#searchresults {
    list-style: none;
-    padding-left: 20px;
+    padding-inline-start: 20px;
 }
 ul#searchresults li {
    margin: 10px 0px;
@@ -346,7 +369,10 @@ ul#searchresults li.focus {
 ul#searchresults span.teaser {
    display: block;
    clear: both;
-    margin: 5px 0 0 20px;
+    margin-block-start: 5px;
+    margin-block-end: 0;
+    margin-inline-start: 20px;
+    margin-inline-end: 0;
    font-size: 0.8em;
 }
 ul#searchresults span.teaser em {
@@ -369,12 +395,14 @@ ul#searchresults span.teaser em {
    background-color: var(--sidebar-bg);
    color: var(--sidebar-fg);
 }
+[dir=rtl] .sidebar { left: unset; right: 0; }
 .sidebar-resizing {
    -moz-user-select: none;
    -webkit-user-select: none;
    -ms-user-select: none;
    user-select: none;
 }
+.no-js .sidebar,
 .js:not(.sidebar-resizing) .sidebar {
    transition: transform 0.3s; /* Animation: slide away */
 }
@@ -398,12 +426,18 @@ ul#searchresults span.teaser em {
    top: 0;
    bottom: 0;
 }
+[dir=rtl] .sidebar .sidebar-resize-handle { right:  unset; left: 0; }
 .js .sidebar .sidebar-resize-handle {
    cursor: col-resize;
    width: 5px;
 }
-.sidebar-hidden .sidebar {
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
    transform: translateX(calc(0px - var(--sidebar-width)));
+    z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+    transform: translateX(var(--sidebar-width));
 }
 .sidebar::-webkit-scrollbar {
    background: var(--sidebar-bg);
@@ -412,19 +446,26 @@ ul#searchresults span.teaser em {
    background: var(--scrollbar);
 }

-.sidebar-visible .page-wrapper {
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
    transform: translateX(var(--sidebar-width));
 }
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+    transform: translateX(calc(0px - var(--sidebar-width)));
+}
@media only screen and (min-width: 620px) {
-    .sidebar-visible .page-wrapper {
+    #sidebar-toggle-anchor:checked ~ .page-wrapper {
+        transform: none;
+        margin-inline-start: var(--sidebar-width);
+    }
+    [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
        transform: none;
-        margin-left: var(--sidebar-width);
    }
 }

 .chapter {
    list-style: none outside none;
-    padding-left: 0;
+    padding-inline-start: 0;
    line-height: 2.2em;
 }

@@ -454,7 +495,7 @@ ul#searchresults span.teaser em {
 .chapter li > a.toggle {
    cursor: pointer;
    display: block;
-    margin-left: auto;
+    margin-inline-start: auto;
    padding: 0 10px;
    user-select: none;
    opacity: 0.68;
@@ -471,7 +512,7 @@ ul#searchresults span.teaser em {

 .chapter li.chapter-item {
    line-height: 1.5em;
-    margin-top: 0.6em;
+    margin-block-start: 0.6em;
 }

 .chapter li.expanded > a.toggle div {
@@ -494,7 +535,7 @@ ul#searchresults span.teaser em {

 .section {
    list-style: none outside none;
-    padding-left: 20px;
+    padding-inline-start: 20px;
    line-height: 1.9em;
 }

@@ -517,6 +558,7 @@ ul#searchresults span.teaser em {
    /* Don't let the children's background extend past the rounded corners. */
    overflow: hidden;
 }
+[dir=rtl] .theme-popup { left: unset;  right: 10px; }
 .theme-popup .default {
    color: var(--icons);
 }
@@ -527,7 +569,7 @@ ul#searchresults span.teaser em {
    padding: 2px 20px;
    line-height: 25px;
    white-space: nowrap;
-    text-align: left;
+    text-align: start;
    cursor: pointer;
    color: inherit;
    background: inherit;
@@ -540,6 +582,6 @@ ul#searchresults span.teaser em {
 .theme-selected::before {
    display: inline-block;
    content: "✓";
-    margin-left: -14px;
+    margin-inline-start: -14px;
    width: 14px;
 }
--- a/src/theme/css/general.css
+++ b/src/theme/css/general.css
@@ -5,6 +5,7 @@
 :root {
    /* Browser default font-size is 16px, this way 1 rem = 10px */
    font-size: 62.5%;
+    color-scheme: var(--color-scheme);
 }

 html {
@@ -24,6 +25,7 @@ body {
 code {
    font-family: var(--mono-font) !important;
    font-size: var(--code-font-size);
+    direction: ltr !important;
 }

 /* make long words/inline code not x overflow */
@@ -47,13 +49,13 @@ h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
 .hide-boring .boring { display: none; }
 .hidden { display: none !important; }

-h2, h3 { margin-top: 2.5em; }
-h4, h5 { margin-top: 2em; }
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }

 .header + .header h3,
 .header + .header h4,
 .header + .header h5 {
-    margin-top: 1em;
+    margin-block-start: 1em;
 }

 h1:target::before,
@@ -64,7 +66,7 @@ h5:target::before,
 h6:target::before {
    display: inline-block;
    content: "»";
-    margin-left: -30px;
+    margin-inline-start: -30px;
    width: 30px;
 }

@@ -73,28 +75,34 @@ h6:target::before {
   https://bugs.webkit.org/show_bug.cgi?id=218076
 */
 :target {
+    /* Safari does not support logical properties */
    scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
 }

 .page {
    outline: 0;
    padding: 0 var(--page-padding);
-    margin-top: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+    margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
 }
 .page-wrapper {
    box-sizing: border-box;
+    background-color: var(--bg);
 }
+.no-js .page-wrapper,
 .js:not(.sidebar-resizing) .page-wrapper {
    transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
 }
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+    transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}

 .content {
    overflow-y: auto;
    padding: 0 5px 50px 5px;
 }
 .content main {
-    margin-left: auto;
-    margin-right: auto;
+    margin-inline-start: auto;
+    margin-inline-end: auto;
    max-width: var(--content-max-width);
 }
 .content p { line-height: 1.45em; }
@@ -144,8 +152,31 @@ blockquote {
    padding: 0 20px;
    color: var(--fg);
    background-color: var(--quote-bg);
-    border-top: .1em solid var(--quote-border);
-    border-bottom: .1em solid var(--quote-border);
+    border-block-start: .1em solid var(--quote-border);
+    border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+    margin: 20px;
+    padding: 0 20px;
+    border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+    position: absolute;
+    width: 3rem;
+    height: 3rem;
+    margin-inline-start: calc(-1.5rem - 21px);
+    content: "ⓘ";
+    text-align: center;
+    background-color: var(--bg);
+    color: var(--warning-border);
+    font-weight: bold;
+    font-size: 2rem;
+}
+
+blockquote .warning:before {
+    background-color: var(--quote-bg);
 }

 kbd {
@@ -163,7 +194,7 @@ kbd {

 :not(.footnote-definition) + .footnote-definition,
 .footnote-definition + :not(.footnote-definition) {
-    margin-top: 2em;
+    margin-block-start: 2em;
 }
 .footnote-definition {
    font-size: 0.9em;
--- a/src/theme/css/print.css
+++ b/src/theme/css/print.css
@@ -8,7 +8,7 @@

 #page-wrapper.page-wrapper {
    transform: none;
-    margin-left: 0px;
+    margin-inline-start: 0px;
    overflow-y: initial;
 }

@@ -23,11 +23,7 @@
 }

 code {
-    background-color: #666666;
-    border-radius: 5px;
-
-    /* Force background to be printed in Chrome */
-    -webkit-print-color-adjust: exact;
+    direction: ltr !important;
 }

 pre > .buttons {
--- a/src/theme/css/variables.css
+++ b/src/theme/css/variables.css
@@ -38,6 +38,8 @@
    --quote-bg: hsl(226, 15%, 17%);
    --quote-border: hsl(226, 15%, 22%);

+    --warning-border: #ff8e00;
+
    --table-border-color: hsl(210, 25%, 13%);
    --table-header-bg: hsl(210, 25%, 28%);
    --table-alternate-bg: hsl(210, 25%, 11%);
@@ -50,6 +52,8 @@
    --searchresults-border-color: #888;
    --searchresults-li-bg: #252932;
    --search-mark-bg: #e3b171;
+
+    --color-scheme: dark;
 }

 .coal {
@@ -78,6 +82,8 @@
    --quote-bg: hsl(234, 21%, 18%);
    --quote-border: hsl(234, 21%, 23%);

+    --warning-border: #ff8e00;
+
    --table-border-color: hsl(200, 7%, 13%);
    --table-header-bg: hsl(200, 7%, 28%);
    --table-alternate-bg: hsl(200, 7%, 11%);
@@ -90,6 +96,8 @@
    --searchresults-border-color: #98a3ad;
    --searchresults-li-bg: #2b2b2f;
    --search-mark-bg: #355c7d;
+
+    --color-scheme: dark;
 }

 .light {
@@ -118,6 +126,8 @@
    --quote-bg: hsl(197, 37%, 96%);
    --quote-border: hsl(197, 37%, 91%);

+    --warning-border: #ff8e00;
+
    --table-border-color: hsl(0, 0%, 95%);
    --table-header-bg: hsl(0, 0%, 80%);
    --table-alternate-bg: hsl(0, 0%, 97%);
@@ -130,6 +140,8 @@
    --searchresults-border-color: #888;
    --searchresults-li-bg: #e4f2fe;
    --search-mark-bg: #a2cff5;
+
+    --color-scheme: light;
 }

 .navy {
@@ -158,6 +170,8 @@
    --quote-bg: hsl(226, 15%, 17%);
    --quote-border: hsl(226, 15%, 22%);

+    --warning-border: #ff8e00;
+
    --table-border-color: hsl(226, 23%, 16%);
    --table-header-bg: hsl(226, 23%, 31%);
    --table-alternate-bg: hsl(226, 23%, 14%);
@@ -170,6 +184,8 @@
    --searchresults-border-color: #5c5c68;
    --searchresults-li-bg: #242430;
    --search-mark-bg: #a2cff5;
+
+    --color-scheme: dark;
 }

 .rust {
@@ -198,6 +214,8 @@
    --quote-bg: hsl(60, 5%, 75%);
    --quote-border: hsl(60, 5%, 70%);

+    --warning-border: #ff8e00;
+
    --table-border-color: hsl(60, 9%, 82%);
    --table-header-bg: #b3a497;
    --table-alternate-bg: hsl(60, 9%, 84%);
@@ -210,6 +228,8 @@
    --searchresults-border-color: #888;
    --searchresults-li-bg: #dec2a2;
    --search-mark-bg: #e69f67;
+
+    --color-scheme: light;
 }

@media (prefers-color-scheme: dark) {
@@ -239,6 +259,8 @@
        --quote-bg: hsl(234, 21%, 18%);
        --quote-border: hsl(234, 21%, 23%);

+        --warning-border: #ff8e00;
+
        --table-border-color: hsl(200, 7%, 13%);
        --table-header-bg: hsl(200, 7%, 28%);
        --table-alternate-bg: hsl(200, 7%, 11%);
--- a/src/theme/index.hbs
+++ b/src/theme/index.hbs
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
-<html lang="{{ language }}" class="sidebar-visible no-js {{ default_theme }}">
+<html lang="{{ language }}" class="{{ default_theme }}" dir="{{ text_direction }}">
    <head>
        <!-- Book generated using mdBook -->
        <meta charset="UTF-8">
        <title>{{ title }}</title>
        {{#if is_print }}
-        <meta name="robots" content="noindex" />
+        <meta name="robots" content="noindex">
        {{/if}}
        {{#if base_url}}
        <base href="{{ base_url }}">
@@ -17,7 +17,7 @@

        <meta name="description" content="{{ description }}">
        <meta name="viewport" content="width=device-width, initial-scale=1">
-        <meta name="theme-color" content="#ffffff" />
+        <meta name="theme-color" content="#ffffff">

        {{#if favicon_svg}}
        <link rel="icon" href="{{ path_to_root }}favicon.svg">
@@ -53,7 +53,7 @@
        <script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
        {{/if}}
    </head>
-    <body>
+    <body class="sidebar-visible no-js">
    <div id="body-container">
        <!-- Provide site root to javascript -->
        <script>
@@ -83,24 +83,29 @@
            try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
            if (theme === null || theme === undefined) { theme = default_theme; }
            var html = document.querySelector('html');
-            html.classList.remove('no-js')
            html.classList.remove('{{ default_theme }}')
            html.classList.add(theme);
-            html.classList.add('js');
+            var body = document.querySelector('body');
+            body.classList.remove('no-js')
+            body.classList.add('js');
        </script>

+        <input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
+
        <!-- Hide / unhide sidebar before it is displayed -->
        <script>
-            var html = document.querySelector('html');
+            var body = document.querySelector('body');
            var sidebar = null;
+            var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
            if (document.body.clientWidth >= 1080) {
                try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
                sidebar = sidebar || 'visible';
            } else {
                sidebar = 'hidden';
            }
-            html.classList.remove('sidebar-visible');
-            html.classList.add("sidebar-" + sidebar);
+            sidebar_toggle.checked = sidebar === 'visible';
+            body.classList.remove('sidebar-visible');
+            body.classList.add("sidebar-" + sidebar);
        </script>

        <nav id="sidebar" class="sidebar" aria-label="Table of contents">
@@ -139,9 +144,9 @@
                <div id="menu-bar-hover-placeholder"></div>
                <div id="menu-bar" class="menu-bar sticky">
                    <div class="left-buttons">
-                        <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
+                        <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
                            <i class="fa fa-bars"></i>
-                        </button>
+                        </label>
                        <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
                            <i class="fa fa-paint-brush"></i>
                        </button>
@@ -217,7 +222,7 @@
                        {{/previous}}

                        {{#next}}
-                            <a rel="next" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                            <a rel="next prefetch" href="{{ path_to_root }}{{link}}" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                                <i class="fa fa-angle-right"></i>
                            </a>
                        {{/next}}
@@ -235,7 +240,7 @@
                {{/previous}}

                {{#next}}
-                    <a rel="next" href="{{ path_to_root }}{{link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
+                    <a rel="next prefetch" href="{{ path_to_root }}{{link}}" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
                        <i class="fa fa-angle-right"></i>
                    </a>
                {{/next}}
--- a/src/utils/fs.rs
+++ b/src/utils/fs.rs
@@ -166,7 +166,7 @@ pub fn copy_files_except_ext(
                        .expect("a file should have a file name...")
                )
            );
-            fs::copy(
+            copy(
                entry.path(),
                &to.join(
                    entry
@@ -180,6 +180,62 @@ pub fn copy_files_except_ext(
    Ok(())
 }

+/// Copies a file.
+fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> Result<()> {
+    let from = from.as_ref();
+    let to = to.as_ref();
+    return copy_inner(from, to)
+        .with_context(|| format!("failed to copy `{}` to `{}`", from.display(), to.display()));
+
+    // This is a workaround for an issue with the macOS file watcher.
+    // Rust's `std::fs::copy` function uses `fclonefileat`, which creates
+    // clones on APFS. Unfortunately fs events seem to trigger on both
+    // sides of the clone, and there doesn't seem to be a way to differentiate
+    // which side it is.
+    // https://github.com/notify-rs/notify/issues/465#issuecomment-1657261035
+    // contains more information.
+    //
+    // This is essentially a copy of the simple copy code path in Rust's
+    // standard library.
+    #[cfg(target_os = "macos")]
+    fn copy_inner(from: &Path, to: &Path) -> Result<()> {
+        use std::fs::OpenOptions;
+        use std::os::unix::fs::{OpenOptionsExt, PermissionsExt};
+
+        let mut reader = File::open(from)?;
+        let metadata = reader.metadata()?;
+        if !metadata.is_file() {
+            anyhow::bail!(
+                "expected a file, `{}` appears to be {:?}",
+                from.display(),
+                metadata.file_type()
+            );
+        }
+        let perm = metadata.permissions();
+        let mut writer = OpenOptions::new()
+            .mode(perm.mode())
+            .write(true)
+            .create(true)
+            .truncate(true)
+            .open(to)?;
+        let writer_metadata = writer.metadata()?;
+        if writer_metadata.is_file() {
+            // Set the correct file permissions, in case the file already existed.
+            // Don't set the permissions on already existing non-files like
+            // pipes/FIFOs or device nodes.
+            writer.set_permissions(perm)?;
+        }
+        std::io::copy(&mut reader, &mut writer)?;
+        Ok(())
+    }
+
+    #[cfg(not(target_os = "macos"))]
+    fn copy_inner(from: &Path, to: &Path) -> Result<()> {
+        fs::copy(from, to)?;
+        Ok(())
+    }
+}
+
 pub fn get_404_output_file(input_404: &Option<String>) -> String {
    input_404
        .as_ref()
--- a/test_book/src/individual/code.md
+++ b/test_book/src/individual/code.md
@@ -10,7 +10,9 @@ This is a codeblock

 ---

-This line contains `inline code`
+This line contains `inline code` mixed with some other stuff. (LTR)
+
+ושורה זו מכילה `inline code` אבל עם טקסט בשפה שנכתבת מימין לשמאל. (RTL)

 ---
Author	SHA1	Message	Date
Eric Huss	94e0a44e15	Merge pull request #2206 from ehuss/bump-version Update to 0.4.35	2023-09-29 22:43:05 +00:00
Eric Huss	f25181f68d	Update to 0.4.35	2023-09-29 14:33:45 -07:00
Eric Huss	cf19eb1386	Fix `text-direction` in documentation.	2023-09-29 14:33:20 -07:00
Eric Huss	0583119698	Merge pull request #2197 from dluschan/patch-1 Update index.hbs	2023-09-22 17:26:27 +00:00
Dmitry Luschan	3389f3db7f	Update index.hbs Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.	2023-09-19 20:44:39 +06:00
Eric Huss	c642f5f8a3	Merge pull request #2187 from notriddle/notriddle/warning-block Add `.warning` class for doc author use	2023-09-09 20:13:10 +00:00
Michael Howell	ceb8b509e2	Add more guides to stock CSS classes	2023-09-08 13:27:02 -07:00
Michael Howell	65dae11e47	Add `.warning` class for doc author use This is designed to be compatible with rustdoc's version, in https://github.com/rust-lang/rust/pull/106561	2023-09-08 13:17:21 -07:00
Dylan DPC	d5b1676216	Merge pull request #2168 from pickfire/prefetch Add prefetch to next link	2023-09-04 18:03:38 +00:00
Eric Huss	09f222baf7	Merge pull request #1641 from cN3rd/rtl Continued work on "Support right-to-left languages"	2023-09-02 23:57:48 +00:00
Eric Huss	802e7bffc3	Make the arrow keys honor RTL. At least to my understanding, the pages will flip in the opposite direction.	2023-09-02 16:44:47 -07:00
Eric Huss	fb272d1afa	Fix theme selector for RTL.	2023-09-02 16:43:21 -07:00
Eric Huss	b871676def	Fix sidebar behavior with RTL.	2023-09-02 16:43:13 -07:00
Eric Huss	869fe2f50d	Remove text_drection_from_lang_code The test above should cover this sufficiently.	2023-09-02 16:42:53 -07:00
Eric Huss	db877b1c9b	Update language list to include missing rtl languages.	2023-09-02 16:42:14 -07:00
Eric Huss	4749f9d97a	Some minor corrections from code review.	2023-09-02 16:41:59 -07:00
cN3rd	8564a7fb51	Add proper test to inline code within the book.	2023-09-02 14:38:02 -07:00
cN3rd	6be98e0bbd	Ensure code segments always render in LTR	2023-09-02 14:37:59 -07:00
cN3rd	5e0c68c45e	Fix icons when using RTL	2023-09-02 07:50:23 -07:00
cN3rd	7717b9dcf2	Support `text_direction` attribute in HTML output	2023-09-02 07:50:21 -07:00
cN3rd	819a108f07	Add `text_direction` property in general book metadata Text direction can selected in the config via the `text_direction` attribute in `book.toml`, or be derived from the book's language.	2023-09-02 07:49:28 -07:00
Tim Crawford	3a99899114	Use CSS selectors to override properties for RTL Fix behavior of some elements when displaying page in RTL. Signed-off-by: Tim Crawford <crawfxrd@gmail.com>	2023-09-02 07:49:28 -07:00
Tim Crawford	1088066c69	Move sidebar, js classes from html to body element This will be necessary for using CSS selectors on root attributes. Signed-off-by: Tim Crawford <crawfxrd@gmail.com>	2023-09-02 07:49:27 -07:00
Tim Crawford	73d44503fd	Use logical CSS properties Replace phyiscal properties (top/bottom/left/right) with logical properties (start/end) that can be used in non-LTR contexts (e.g., content in Arabic or Hebrew). Based on the CSS Logical Properties and Values Level 1 specification, currently an Editor's Draft [1]. Referencing MDN, all major browsers except Internet Explorer support the margin, padding, and border properties. [1]: https://drafts.csswg.org/css-logical/ Signed-off-by: Tim Crawford <crawfxrd@gmail.com>	2023-09-02 07:47:12 -07:00
Eric Huss	25aaff0bd6	Merge pull request #2182 from cuishuang/master remove the repetitive word	2023-09-02 13:41:15 +00:00
cui fliter	29691461c5	remove the repetitive word Signed-off-by: cui fliter <imcusg@gmail.com>	2023-09-02 14:04:32 +08:00
Dylan DPC	a74e4dcec8	Merge pull request #2181 from tshepang/patch-1 docs: future expansion to non-Rust testing already implied	2023-09-01 08:55:38 +00:00
Tshepang Mbambo	0b0b548d7a	docs: future expansion to non-Rust testing already implied	2023-09-01 05:11:18 +02:00
Dylan DPC	02f3823e4c	Merge pull request #2175 from qaqland/sidebar-pure-css Sidebar but Pure CSS, fix rust-lang/mdBook#859	2023-08-24 13:11:14 +00:00
qaqland	36327efe9d	Sidebar but Pure CSS, fix rust-lang/mdBook#859 * change sidebar-toggle button by input:checked and label * change nav-wrappers' CSS selectors * remove loading animation when page opens with z-index	2023-08-24 16:44:25 +08:00
Ivan Tham	c9f1d01346	Add prefetch to next link Fix #1975	2023-08-17 00:50:47 +08:00
Eric Huss	56c225bd34	Merge pull request #2158 from ehuss/bump-version Update to 0.4.34	2023-08-05 21:54:12 +00:00
Eric Huss	55c017cad1	Update to 0.4.34	2023-08-05 14:34:42 -07:00
Eric Huss	7849d55b99	Merge pull request #2157 from ehuss/macos-notify-copy Add workaround for macOS notify problem.	2023-08-05 20:35:33 +00:00
Eric Huss	c903cc8827	Add workaround for macOS notify problem.	2023-08-05 13:23:17 -07:00
Eric Huss	4a797b9565	Revert "Merge pull request #2152 from ehuss/macos-notify-kqueue" This reverts commit `347e7886e1`, reversing changes made to `a8fd6038f1`.	2023-08-05 12:53:23 -07:00
Eric Huss	57b487eaa3	Merge pull request #2154 from ehuss/bump-version Update to 0.4.33	2023-08-04 00:11:45 +00:00
Eric Huss	891b7c06f2	Update to 0.4.33	2023-08-03 17:03:40 -07:00
Eric Huss	f7e212ec9c	Merge pull request #2150 from proski/header-code-background Don't use distinct background for code in headers when printing	2023-08-03 22:46:50 +00:00
Pavel Roskin	228538ea62	Don't use distinct background for code in headers when printing Fixes #1933	2023-08-02 23:31:46 -07:00
Eric Huss	347e7886e1	Merge pull request #2152 from ehuss/macos-notify-kqueue Switch macOS notify to kqueue.	2023-08-02 22:13:09 +00:00
Eric Huss	bfa5fb8844	Switch macOS notify to kqueue.	2023-08-02 09:21:25 -07:00
Eric Huss	a8fd6038f1	Merge pull request #2151 from ehuss/revert-toml Revert toml update	2023-08-02 15:49:44 +00:00
Eric Huss	fbfe887084	Add note to not update toml.	2023-08-02 08:39:23 -07:00
Eric Huss	aed991f75f	Revert "Merge pull request #2125 from ehuss/update-toml" This reverts commit `89797064b8`, reversing changes made to `7824aed878`.	2023-08-02 08:32:44 -07:00
Eric Huss	ab2cb71c00	Merge pull request #2134 from GiorgioReale/master Enhancing themes with `color-scheme: light \| dark;` implementation in CSS	2023-07-30 22:50:08 +00:00
Giorgio Reale	fcfde083e7	Enhancing themes with `color-scheme: light \| dark;` implementation in CSS	2023-07-30 15:43:51 -07:00
Eric Huss	4614a3637a	Merge pull request #2146 from riverbl/fix-extra-watch-dirs Fix issues with extra-watch-dirs	2023-07-30 17:08:46 +00:00
Eric Huss	d450544d6b	Merge pull request #2148 from ehuss/fix-merge-queue Use a better merge-queue success check.	2023-07-29 16:23:04 +00:00
Eric Huss	9340e6a78d	Use a better merge-queue success check.	2023-07-29 09:13:55 -07:00
riverbl	e00b8835cc	Fix issues with extra-watch-dirs Fix paths specified in extra-watch-dirs being relative to the current working directory rather than the book root If there is an error canonicalising paths in extra-watch-dirs, log the error and exit rather than panicking	2023-07-28 20:07:20 +01:00
Eric Huss	429ca06289	Merge pull request #2140 from ehuss/merge-queue-workflow Prepare CI workflows to support merge queues.	2023-07-24 20:35:16 -07:00
Eric Huss	0fbfc90bea	Prepare CI workflows to support merge queues.	2023-07-24 20:16:07 -07:00
Eric Huss	581e5025a2	Merge pull request #2139 from tshepang/patch-1 misplaced bracket	2023-07-21 07:32:56 -07:00
Tshepang Mbambo	e57fce290b	misplaced bracket	2023-07-21 15:29:56 +02:00
Eric Huss	d5a3682de9	Merge pull request #2137 from ehuss/mdbook-case-link Fix link on case-sensitive filesystems.	2023-07-19 08:06:35 -07:00
Eric Huss	75f5862218	Fix link on case-sensitive filesystems.	2023-07-19 07:54:39 -07:00
Eric Huss	aed518f945	Merge pull request #2129 from ehuss/bump-version Update to 0.4.32	2023-07-16 17:43:49 -07:00
Eric Huss	e942d41c1d	Merge pull request #2128 from ehuss/release-token-perms deploy: Rewrite and update permissions	2023-07-16 17:38:21 -07:00
Eric Huss	38fcfd8732	Update to 0.4.32	2023-07-16 17:35:51 -07:00
Eric Huss	82ec68128d	Merge pull request #2127 from ehuss/auto-publish Automatically publish to crates.io on new release	2023-07-16 17:28:50 -07:00
Eric Huss	9497354cfd	Rewrite asset deploy. This switches to `gh` which is the more modern CLI, and also available by default which removes the old installer script. This also tightens the scope where GITHUB_TOKEN is exposed to just the step where `gh` is executed. Finally, it tightens the permissions on the GITHUB_TOKEN (though `contents: write` is extremely permissive, since that allows writing to almost anything in the repo).	2023-07-16 17:16:15 -07:00
Eric Huss	baa936439d	deploy: Set the default shell so it doesn't need to be repeated.	2023-07-16 17:12:55 -07:00
Eric Huss	394061d28d	Rename make-release.sh to make-release-asset.sh This is to better reflect what the script does.	2023-07-16 17:12:29 -07:00
Eric Huss	0f25db67dc	Automatically publish to crates.io on new release	2023-07-16 16:29:45 -07:00
Eric Huss	49ba91961f	Merge pull request #2126 from ehuss/update-deps Update dependencies	2023-07-16 13:32:55 -07:00
Eric Huss	28ce772ae9	Update msrv to 1.66.	2023-07-16 13:21:45 -07:00
Eric Huss	424c2d9f6b	Update dependencies	2023-07-16 13:09:52 -07:00
Eric Huss	89797064b8	Merge pull request #2125 from ehuss/update-toml Update toml to 0.7.6	2023-07-16 13:08:40 -07:00
Eric Huss	7824aed878	Merge pull request #2124 from ehuss/update-predicates Update predicates to 3.0.3	2023-07-16 12:51:51 -07:00
Eric Huss	8236c43c90	Merge pull request #2123 from ehuss/update-notify Update notify to 6.0.1	2023-07-16 12:50:17 -07:00
Eric Huss	6df89fbe94	Merge pull request #2122 from ehuss/update-opener Update opener to 0.6.1	2023-07-16 12:50:10 -07:00
Eric Huss	b423bf7ddd	Update toml to 0.7.6	2023-07-16 12:48:01 -07:00
Eric Huss	cdbdb8248c	Merge pull request #2121 from ehuss/update-clap Update to clap 4.3.12	2023-07-16 12:43:44 -07:00
Eric Huss	db45052d7e	Update predicates to 3.0.3	2023-07-16 12:42:44 -07:00
Eric Huss	804bbf6564	Update notify to 6.0.1	2023-07-16 12:40:45 -07:00
Eric Huss	bd3b9bacf6	Update opener to 0.6.1	2023-07-16 12:37:23 -07:00
Eric Huss	5505d57066	Update to clap 4.3.12	2023-07-16 12:33:53 -07:00
Eric Huss	cf88c4e720	Merge pull request #2116 from Stargateur/patch-1 Add oh-my-zsh quick exemple to shell completions	2023-07-16 10:59:37 -07:00
Eric Huss	9911e86039	Merge pull request #2118 from zica87/zica87-patch-1 Fix theme-color meta tag not syncing with the theme	2023-07-16 10:55:53 -07:00
zica	9eba0f6ab2	Fix theme-color meta tag not syncing with the theme	2023-07-09 08:57:46 +08:00
Antoine	6d265c1cce	Add oh-my-zsh quick exemple to shell completions I have trouble to find this information, doesn't cost must to add it here.	2023-07-08 13:48:51 +02:00