docs: fix mdbook-toc build failure

chore: prep v1.11.0 release

.github/workflows/deploy.yml

@@ -16,14 +16,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        target:
-          - x86_64-unknown-linux-gnu
-          - x86_64-unknown-linux-musl
-          - x86_64-apple-darwin
-          - x86_64-pc-windows-msvc
         include:
-          - target: x86_64-unknown-linux-gnu
+          - target: aarch64-unknown-linux-musl
             os: ubuntu-latest
+            name: aarch64-unknown-linux-musl.tar.gz
+          - target: x86_64-unknown-linux-gnu
+            # Deliberately pinned to the same version `mdbook` uses to build
+            # binaries, so we use the same glibc version
+            #
+            # ref: https://github.com/rust-lang/mdBook/pull/1955
+            os: ubuntu-20.04
             name: x86_64-unknown-linux-gnu.tar.gz
           - target: x86_64-unknown-linux-musl
             os: ubuntu-latest
@@ -56,17 +58,19 @@ jobs:
           profile: minimal
           target: ${{ matrix.target }}
 
-      - name: Setup | musl tools
-        if: matrix.target == 'x86_64-unknown-linux-musl'
-        run: sudo apt install -y musl-tools
+      - name: Setup | cross
+        if: endsWith(matrix.target, '-unknown-linux-musl')
+        uses: taiki-e/install-action@v2
+        with:
+          tool: cross
 
       - name: Build | Build
-        if: matrix.target != 'x86_64-unknown-linux-musl'
+        if: ${{ !endsWith(matrix.target, '-unknown-linux-musl') }}
         run: cargo build --release --target ${{ matrix.target }}
 
       - name: Build | Build (musl)
-        if: matrix.target == 'x86_64-unknown-linux-musl'
-        run: cargo build --release --target ${{ matrix.target }}
+        if: endsWith(matrix.target, '-unknown-linux-musl')
+        run: cross build --release --target ${{ matrix.target }}
 
       - name: Post Setup | Extract tag name
         shell: bash
@@ -78,7 +82,6 @@ jobs:
         run: |
           mkdir target/stage
           cd target/${{ matrix.target }}/release
-          strip ${{ env.CRATE_NAME }}.exe
           7z a ../../stage/${{ env.CRATE_NAME }}-${{ steps.extract_tag.outputs.tag }}-${{ matrix.name }} ${{ env.CRATE_NAME }}.exe
           cd -
       - name: Post Setup | Prepare artifacts [-nix]
@@ -86,7 +89,6 @@ jobs:
         run: |
           mkdir target/stage
           cd target/${{ matrix.target }}/release
-          strip ${{ env.CRATE_NAME }}
           tar czvf ../../stage/${{ env.CRATE_NAME }}-${{ steps.extract_tag.outputs.tag }}-${{ matrix.name }} ${{ env.CRATE_NAME }}
           cd -
       - name: Post Setup | Upload artifacts

CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## Unreleased
 
+## 1.11.0
+
+### Changed
+
+- `gnu` prebuilt binaries are now built on `ubuntu-20.04` to match `mdbook` binaries. Thanks to [@eitsupi](https://github.com/eitsupi) for the fix! ([#118](https://github.com/tommilligan/mdbook-admonish/pull/118))
+
+### Added
+
+- `aarch64-unknown-linux-musl` prebuilt binary now available ([#119](https://github.com/tommilligan/mdbook-admonish/pull/119))
+
+## 1.10.2
+
+### Fixed
+
+- Fixed `cargo install mdbook-admonish` failing due to an internal dependency mismatch with `mdbook` ([#115](https://github.com/tommilligan/mdbook-admonish/pull/115))
+
+## 1.10.1
+
+### Fixed
+
+- Only restyle `summary` elements generated by `mdbook-admonish`. Thanks to [@ImUrX](https://github.com/ImUrX) for the report and fix! ([#112](https://github.com/tommilligan/mdbook-admonish/pull/112))
+
+## 1.10.0
+
+### Changed
+
+- MSRV (minimum supported rust version) is now 1.66.0 for mdbook v0.4.32 ([#109](https://github.com/tommilligan/mdbook-admonish/pull/109))
+
+### Added
+
+- Support `mdbook test` running doctests inside admonish blocks. Opt-in to this by setting `renderer.test.action_mode = "strip"` ([#109](https://github.com/tommilligan/mdbook-admonish/pull/109))
+- Log a warning when an invalid admonish block is encountered ([#109](https://github.com/tommilligan/mdbook-admonish/pull/109))
+
+### Fixed
+
+- Document all `book.toml` configuration options [in the reference](https://tommilligan.github.io/mdbook-admonish/reference.html), some of which were previously undocumened ([#109](https://github.com/tommilligan/mdbook-admonish/pull/109))
+
 ## 1.9.0
 
 ### Changed

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "mdbook-admonish"
-version = "1.9.0"
+version = "1.11.0"
 edition = "2021"
 
 authors = ["Tom Milligan <code@tommilligan.net>"]
@@ -17,27 +17,33 @@ name = "mdbook-admonish"
 path = "src/bin/mdbook-admonish.rs"
 required-features = ["cli"]
 
+[profile.release]
+strip = true
+
 [lib]
 name = "mdbook_admonish"
 path = "src/lib.rs"
 
 [dependencies]
-anyhow = "1.0.65"
+anyhow = "1.0.72"
 clap = { version = "4", default_features = false, features = ["std", "derive"], optional = true }
 env_logger = { version = "0.10", default_features = false, optional = true }
-log = "0.4.17"
-mdbook = "0.4.32"
-once_cell = "1.15.0"
-pulldown-cmark = "0.9.2"
-regex = "1.6.0"
-semver = "1.0.14"
-serde = { version = "1.0.145", features = ["derive"] }
-serde_json = "1.0.85"
-toml = "0.7.3"
-toml_edit = { version = "0.19.8", optional = true }
+log = "0.4.19"
+mdbook = "0.4.34"
+once_cell = "1.18.0"
+pulldown-cmark = "0.9.3"
+regex = "1.9.3"
+semver = "1.0.18"
+serde = { version = "1.0.183", features = ["derive"] }
+serde_json = "1.0.104"
+# The version of toml that mdbook uses internally (and uses in it's public api)
+# Only used for compatilibilty with the mdbook public api
+toml_mdbook = { package = "toml", version = "0.5.11" }
+toml = "0.7.6"
+toml_edit = { version = "0.19.14", optional = true }
 
 [dev-dependencies]
-pretty_assertions = "1.3.0"
+pretty_assertions = "1.4.0"
 
 [features]
 default = ["cli", "cli-install"]

README.md

@@ -174,8 +174,6 @@ You must make the next `mdbook-admonish` crate version at least a **minor** vers
 
 Github workflows are setup such that pushing a `vX.Y.Z` tag will trigger a release to be cut.
 
-Once the release is created, copy and paste the relevant section of `CHANGELOG.md` manually to update the description.
-
 ## Thanks
 
 This utility is heavily drawn from and inspired by other projects, namely:

book/book.toml

@@ -9,7 +9,7 @@ title = "The mdbook-admonish book"
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
+assets_version = "2.0.2" # do not edit: managed by `mdbook-admonish install`
 
 [preprocessor.toc]
 command = "mdbook-toc"

book/scripts/install-mdbook-extras

@@ -5,5 +5,5 @@ set -exuo pipefail
 cd "$(dirname "$0")"/../..
 
 if ! mdbook-toc --version; then
-  cargo install mdbook-toc --version 0.13.0 --force
+  cargo install mdbook-toc --version 0.14.1 --force
 fi

book/src/overview.md

@@ -7,7 +7,7 @@
 [![Latest version](https://img.shields.io/crates/v/mdbook-admonish.svg)](https://crates.io/crates/mdbook-admonish)
 [![docs.rs](https://img.shields.io/docsrs/mdbook-admonish)](https://docs.rs/mdbook-admonish)
 
-A preprocessor for [mdbook](https://github.com/rust-lang-nursery/mdBook) to add [Material Design](https://material.io/design) admonishments, based on the [mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) implementation.
+A preprocessor for [mdbook](https://github.com/rust-lang/mdBook) to add [Material Design](https://material.io/design) admonishments, based on the [mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) implementation.
 
 It turns this:
 
@@ -39,7 +39,7 @@ My example is the best!
 My example is the best!
 ```
 
-See the [list of directives](./reference.md) for a full list of supported admonitions. You'll find:
+See the [list of directives](./reference.md#directives) for a full list of supported admonitions. You'll find:
 
 - `info`
 - `warning`
@@ -74,13 +74,13 @@ This block will error
 This block will error
 ```
 
-You can also configure the build to fail loudly, by setting `on_failure = "bail"` in `book.toml`. See the [configuration reference](./reference.md) for more details.
+You can also configure the build to fail loudly, by setting `on_failure = "bail"` in `book.toml`. See the [configuration reference](./reference.md#booktoml-configuration) for more details.
 
 ### Additional Options
 
 You can pass additional options to each block. The options are structured as TOML key-value pairs.
 
-Note that some options can be passed globally, through the `default` section in `book.toml`. See the [configuration reference](./reference.md) for more details.
+Note that some options can be passed globally, through the `default` section in `book.toml`. See the [configuration reference](./reference.md#booktoml-configuration) for more details.
 
 #### Custom title
 

book/v2.md

@@ -0,0 +1,6 @@
+# Notes for a v2 release
+
+## Default behaviour changes
+
+- `on_failure` default changed from `continue` to `bail`
+- `preprocessor.admonish.renderer.test.render_mode` default changed from `preserve` to `strip`

compile_assets/scss/admonition.scss

@@ -143,7 +143,7 @@ a.admonition-anchor-link {
 }
 
 // Admonition title
-:is(.admonition-title, summary) {
+:is(.admonition-title, summary.admonition-title) {
   position: relative;
   min-height: 4rem;
   margin-block: 0;
@@ -233,7 +233,7 @@ summary.admonition-title {
   }
 
   // Admonition flavour title
-  :is(#{$flavours}) > :is(.admonition-title, summary) {
+  :is(#{$flavours}) > :is(.admonition-title, summary.admonition-title) {
     background-color: color.adjust($tint, $alpha: -0.9);
 
     // Admonition icon

integration/book.toml

@@ -9,7 +9,7 @@ title = "mdbook-admonish-integration"
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "2.0.1" # do not edit: managed by `mdbook-admonish install`
+assets_version = "2.0.2" # do not edit: managed by `mdbook-admonish install`
 after = ["links"]
 
 [preprocessor.admonish.renderer.test]

integration/expected/book.toml

@@ -9,7 +9,7 @@ title = "mdbook-admonish-integration"
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "2.0.1" # do not edit: managed by `mdbook-admonish install`
+assets_version = "2.0.2" # do not edit: managed by `mdbook-admonish install`
 after = ["links"]
 
 [preprocessor.admonish.renderer.test]

src/bin/assets/VERSION

@@ -1 +1 @@
-2.0.1
+2.0.2

src/bin/assets/mdbook-admonish.css

@@ -75,7 +75,7 @@ a.admonition-anchor-link::before {
   content: "§";
 }
 
-:is(.admonition-title, summary) {
+:is(.admonition-title, summary.admonition-title) {
   position: relative;
   min-height: 4rem;
   margin-block: 0;
@@ -86,13 +86,13 @@ a.admonition-anchor-link::before {
   background-color: rgba(68, 138, 255, 0.1);
   display: flex;
 }
-:is(.admonition-title, summary) p {
+:is(.admonition-title, summary.admonition-title) p {
   margin: 0;
 }
-html :is(.admonition-title, summary):last-child {
+html :is(.admonition-title, summary.admonition-title):last-child {
   margin-bottom: 0;
 }
-:is(.admonition-title, summary)::before {
+:is(.admonition-title, summary.admonition-title)::before {
   position: absolute;
   top: 0.625em;
   inset-inline-start: 1.6rem;
@@ -107,7 +107,7 @@ html :is(.admonition-title, summary):last-child {
   -webkit-mask-size: contain;
   content: "";
 }
-:is(.admonition-title, summary):hover a.admonition-anchor-link {
+:is(.admonition-title, summary.admonition-title):hover a.admonition-anchor-link {
   display: initial;
 }
 
@@ -136,10 +136,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #448aff;
 }
 
-:is(.note) > :is(.admonition-title, summary) {
+:is(.note) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(68, 138, 255, 0.1);
 }
-:is(.note) > :is(.admonition-title, summary)::before {
+:is(.note) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #448aff;
   mask-image: var(--md-admonition-icon--note);
   -webkit-mask-image: var(--md-admonition-icon--note);
@@ -153,10 +153,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #00b0ff;
 }
 
-:is(.abstract, .summary, .tldr) > :is(.admonition-title, summary) {
+:is(.abstract, .summary, .tldr) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(0, 176, 255, 0.1);
 }
-:is(.abstract, .summary, .tldr) > :is(.admonition-title, summary)::before {
+:is(.abstract, .summary, .tldr) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #00b0ff;
   mask-image: var(--md-admonition-icon--abstract);
   -webkit-mask-image: var(--md-admonition-icon--abstract);
@@ -170,10 +170,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #00b8d4;
 }
 
-:is(.info, .todo) > :is(.admonition-title, summary) {
+:is(.info, .todo) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(0, 184, 212, 0.1);
 }
-:is(.info, .todo) > :is(.admonition-title, summary)::before {
+:is(.info, .todo) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #00b8d4;
   mask-image: var(--md-admonition-icon--info);
   -webkit-mask-image: var(--md-admonition-icon--info);
@@ -187,10 +187,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #00bfa5;
 }
 
-:is(.tip, .hint, .important) > :is(.admonition-title, summary) {
+:is(.tip, .hint, .important) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(0, 191, 165, 0.1);
 }
-:is(.tip, .hint, .important) > :is(.admonition-title, summary)::before {
+:is(.tip, .hint, .important) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #00bfa5;
   mask-image: var(--md-admonition-icon--tip);
   -webkit-mask-image: var(--md-admonition-icon--tip);
@@ -204,10 +204,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #00c853;
 }
 
-:is(.success, .check, .done) > :is(.admonition-title, summary) {
+:is(.success, .check, .done) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(0, 200, 83, 0.1);
 }
-:is(.success, .check, .done) > :is(.admonition-title, summary)::before {
+:is(.success, .check, .done) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #00c853;
   mask-image: var(--md-admonition-icon--success);
   -webkit-mask-image: var(--md-admonition-icon--success);
@@ -221,10 +221,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #64dd17;
 }
 
-:is(.question, .help, .faq) > :is(.admonition-title, summary) {
+:is(.question, .help, .faq) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(100, 221, 23, 0.1);
 }
-:is(.question, .help, .faq) > :is(.admonition-title, summary)::before {
+:is(.question, .help, .faq) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #64dd17;
   mask-image: var(--md-admonition-icon--question);
   -webkit-mask-image: var(--md-admonition-icon--question);
@@ -238,10 +238,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #ff9100;
 }
 
-:is(.warning, .caution, .attention) > :is(.admonition-title, summary) {
+:is(.warning, .caution, .attention) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(255, 145, 0, 0.1);
 }
-:is(.warning, .caution, .attention) > :is(.admonition-title, summary)::before {
+:is(.warning, .caution, .attention) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #ff9100;
   mask-image: var(--md-admonition-icon--warning);
   -webkit-mask-image: var(--md-admonition-icon--warning);
@@ -255,10 +255,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #ff5252;
 }
 
-:is(.failure, .fail, .missing) > :is(.admonition-title, summary) {
+:is(.failure, .fail, .missing) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(255, 82, 82, 0.1);
 }
-:is(.failure, .fail, .missing) > :is(.admonition-title, summary)::before {
+:is(.failure, .fail, .missing) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #ff5252;
   mask-image: var(--md-admonition-icon--failure);
   -webkit-mask-image: var(--md-admonition-icon--failure);
@@ -272,10 +272,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #ff1744;
 }
 
-:is(.danger, .error) > :is(.admonition-title, summary) {
+:is(.danger, .error) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(255, 23, 68, 0.1);
 }
-:is(.danger, .error) > :is(.admonition-title, summary)::before {
+:is(.danger, .error) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #ff1744;
   mask-image: var(--md-admonition-icon--danger);
   -webkit-mask-image: var(--md-admonition-icon--danger);
@@ -289,10 +289,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #f50057;
 }
 
-:is(.bug) > :is(.admonition-title, summary) {
+:is(.bug) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(245, 0, 87, 0.1);
 }
-:is(.bug) > :is(.admonition-title, summary)::before {
+:is(.bug) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #f50057;
   mask-image: var(--md-admonition-icon--bug);
   -webkit-mask-image: var(--md-admonition-icon--bug);
@@ -306,10 +306,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #7c4dff;
 }
 
-:is(.example) > :is(.admonition-title, summary) {
+:is(.example) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(124, 77, 255, 0.1);
 }
-:is(.example) > :is(.admonition-title, summary)::before {
+:is(.example) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #7c4dff;
   mask-image: var(--md-admonition-icon--example);
   -webkit-mask-image: var(--md-admonition-icon--example);
@@ -323,10 +323,10 @@ details[open].admonition > summary.admonition-title::after {
   border-color: #9e9e9e;
 }
 
-:is(.quote, .cite) > :is(.admonition-title, summary) {
+:is(.quote, .cite) > :is(.admonition-title, summary.admonition-title) {
   background-color: rgba(158, 158, 158, 0.1);
 }
-:is(.quote, .cite) > :is(.admonition-title, summary)::before {
+:is(.quote, .cite) > :is(.admonition-title, summary.admonition-title)::before {
   background-color: #9e9e9e;
   mask-image: var(--md-admonition-icon--quote);
   -webkit-mask-image: var(--md-admonition-icon--quote);

src/book_config.rs

@@ -5,15 +5,17 @@ use std::collections::HashMap;
 
 use crate::types::AdmonitionDefaults;
 
+/// Loads the plugin configuration from mdbook internals.
+///
+/// Roundtrips config to string, to avoid linking the plugin's internal version of toml
+/// to the one publically exposed by the mdbook library.
 pub(crate) fn admonish_config_from_context(ctx: &PreprocessorContext) -> Result<Config> {
-    let table: toml::Table = ctx
-        .config
-        .get_preprocessor("admonish")
-        .context("No configuration for mdbook-admonish in book.toml")?
-        .to_owned();
-    table
-        .try_into()
-        .context("Invalid mdbook-admonish configuration in book.toml")
+    let table: String = toml_mdbook::to_string(
+        ctx.config
+            .get_preprocessor("admonish")
+            .context("No configuration for mdbook-admonish in book.toml")?,
+    )?;
+    toml::from_str(&table).context("Invalid mdbook-admonish configuration in book.toml")
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]

src/markdown.rs

@@ -418,7 +418,7 @@ Will have bonus classnames
 ```
 "#;
 
-        let expected = r##"
+        let expected = r#"
 
 <div id="admonition-default" class="admonition note">
 <div>
@@ -427,7 +427,7 @@ Will have bonus classnames
 
 </div>
 </div>
-"##;
+"#;
 
         assert_eq!(expected, prep(content));
     }
@@ -684,7 +684,7 @@ A simple admonition.
 Text
 "#;
 
-        let expected = r##"# Chapter
+        let expected = r#"# Chapter
 
 <div id="admonition-default" class="admonition note">
 <div>
@@ -694,7 +694,7 @@ A simple admonition.
 </div>
 </div>
 Text
-"##;
+"#;
 
         let preprocess_result = preprocess(
             content,
@@ -718,7 +718,7 @@ A simple admonition.
 Text
 "#;
 
-        let expected = r##"# Chapter
+        let expected = r#"# Chapter
 
 <div id="admonition-default" class="admonition note">
 <div>
@@ -728,7 +728,7 @@ A simple admonition.
 </div>
 </div>
 Text
-"##;
+"#;
 
         assert_eq!(expected, prep(content));
     }