Skip to content

Commit 69f5a4f

Browse files
committed
fix: update to latest mdbook fixing build errors
1 parent b97ca32 commit 69f5a4f

4 files changed

Lines changed: 5 additions & 20 deletions

File tree

.github/workflows/mdbook.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ jobs:
2929
build:
3030
runs-on: ubuntu-latest
3131
env:
32-
MDBOOK_VERSION: 0.4.52
33-
MDBOOK_MERMAID_VERSION: 0.10.0
3432
CARGO_HOME: ${{ github.workspace }}/.cargo
3533
RUSTUP_HOME: ${{ github.workspace }}/.rustup
3634
steps:
@@ -39,8 +37,6 @@ jobs:
3937
run: bash scripts/install-mdbook.sh
4038
env:
4139
REPO_ROOT: ${{ github.workspace }}
42-
MDBOOK_VERSION: ${{ env.MDBOOK_VERSION }}
43-
MDBOOK_MERMAID_VERSION: ${{ env.MDBOOK_MERMAID_VERSION }}
4440
- name: Setup Pages
4541
id: pages
4642
uses: actions/configure-pages@v5

MDBOOK.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,10 @@ cargo install mdbook --version 0.4.52
2020
Install required preprocessors:
2121

2222
```sh
23-
# Install mdbook-mermaid v0.10.0 (compatible with mdbook 0.4.52)
24-
cargo install mdbook-mermaid --version 0.10.0
25-
26-
# Install mdbook-embedify for embedding external content
23+
cargo install mdbook-mermaid
2724
cargo install mdbook-embedify
2825
```
2926

30-
**Note:** These specific versions are required for compatibility. mdbook-embedify 0.2.18 is not compatible with mdbook 0.5.x, so we use mdbook 0.4.52 and a compatible version of mdbook-mermaid.
31-
3227
## Usage
3328

3429
To build the book, run the following command:

mdbook

Lines changed: 0 additions & 4 deletions
This file was deleted.

scripts/install-mdbook.sh

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
# Usage: ./scripts/install-mdbook.sh (from repo root)
44
set -e
55

6-
MDBOOK_VERSION="${MDBOOK_VERSION:-0.4.52}"
7-
MDBOOK_MERMAID_VERSION="${MDBOOK_MERMAID_VERSION:-0.10.0}"
6+
MDBOOK_VERSION="${MDBOOK_VERSION:-0.5.2}"
7+
MDBOOK_MERMAID_VERSION="${MDBOOK_MERMAID_VERSION:-0.17.0}"
8+
MDBOOK_EMBEDIFY_VERSION="${MDBOOK_EMBEDIFY_VERSION:-0.3.2}"
89

910
# Install into repo so CI and local use the same layout (avoids cross-device issues in act)
1011
REPO_ROOT="${REPO_ROOT:-$(git rev-parse --show-toplevel 2>/dev/null || echo "$PWD")}"
@@ -17,12 +18,9 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --no-mod
1718
source "${CARGO_HOME}/env"
1819
rustup update
1920

20-
# Install mdbook v0.4.52 (required for mdbook-embedify compatibility)
2121
cargo install --version "${MDBOOK_VERSION}" mdbook
22-
# Install mdbook-mermaid v0.10.0 (compatible with mdbook 0.4.52)
2322
cargo install --version "${MDBOOK_MERMAID_VERSION}" mdbook-mermaid
24-
# Install mdbook-embedify (latest version compatible with mdbook 0.4.52)
25-
cargo install mdbook-embedify
23+
cargo install --version "${MDBOOK_EMBEDIFY_VERSION}" mdbook-embedify
2624

2725
echo "Done. To build the book, use the project mdbook (do not use your global 'mdbook'):"
2826
echo " ./mdbook build"

0 commit comments

Comments
 (0)