Skip to content

Upgrade crates to support mdBook 0.5 breaking changes #652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avivace merged 6 commits into from
Mar 26, 2026
+631 −812
Merged

Upgrade crates to support mdBook 0.5 breaking changes #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0f99742
Remove multilingual from book.toml
mtthgn Mar 25, 2026
70eaff3
Update preprocessor and renderer to use their appropriate cargo crates
mtthgn Mar 25, 2026
e758ad2
Update Github workflows to account for the mdBook upgrade
mtthgn Mar 26, 2026
c05322b
Dockerfile: lock to 0.5.2
avivace Mar 26, 2026
a11b2f1
docs: update instructions for mdbook 0.5.2
avivace Mar 26, 2026
4ea7aa2
linkcheck: stop checking external links
avivace Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 10 additions & 19 deletions .github/workflows/build-and-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@ concurrency:
cancel-in-progress: false

env:
MDBOOK_LINKCHECK_VER: 0.7.7
Comment thread
mtthgn marked this conversation as resolved.
MDBOOK_VERSION: 0.5.2
MDBOOK_LINKCHECK2_VERSION: 0.12.0

jobs:
build:
name: Build Pan Docs
runs-on: ubuntu-latest
steps:
- uses: dtolnay/rust-toolchain@stable
- name: Checkout pandocs
uses: actions/checkout@v4
with:
Expand All @@ -45,9 +47,7 @@ jobs:
workspaces: pandocs/

- name: Install mdbook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: 0.4.40
run: cargo install mdbook@${MDBOOK_VERSION}

- name: Install static-sitemap-cli
run: npm install static-sitemap-cli
Expand Down Expand Up @@ -78,6 +78,7 @@ jobs:
name: Check for dead links
runs-on: ubuntu-latest
steps:
- uses: dtolnay/rust-toolchain@stable
- name: Checkout pandocs
uses: actions/checkout@v4
with:
Expand All @@ -88,17 +89,10 @@ jobs:
with:
workspaces: pandocs/

- name: Install mdbook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: 0.4.40

# FIXME: Keep this up to date
- name: Install mdbook-linkcheck
run: | # `-L` because GitHub performs a redirection
curl -L -o mdbook-linkcheck.zip "https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v${MDBOOK_LINKCHECK_VER}/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip"
unzip mdbook-linkcheck.zip mdbook-linkcheck
chmod +x mdbook-linkcheck
- name: Install mdbook dependencies
run: |
cargo install mdbook@${MDBOOK_VERSION}
cargo install mdbook-linkcheck2@${MDBOOK_LINKCHECK2_VERSION}

- name: Install Python dependencies
run: |
Expand All @@ -107,10 +101,7 @@ jobs:

- name: Check links
working-directory: pandocs/
env:
MDBOOK_OUTPUT__LINKCHECK__COMMAND: "../mdbook-linkcheck"
run: |
mdbook build
run: mdbook build

deploy:
name: Deploy to GitHub pages
Expand Down
Loading
Loading