Skip to content

Commit 3ae4a29

Browse files
authored
Formatting fixes for "Relink Don't Rebuild" (25H2) (#357)
* update `mdbook`: 0.4.40 → 0.4.52 0.4.48 changes how footnotes are rendered (more in line w/GFM): https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-0448 * rdr: use `mdbook`'s `class="warning"` instead of GFM alert ([`mdbook-alerts`](https://github.com/lambdalisue/rs-mdbook-alerts) exists but since we've only got the one usage...) * add `mdbook-mermaid` note: running `mdbook-mermaid install` before building the book rather than vendoring `mermaid.min.js`/`mermaid-init.js` into the repo
1 parent b823f0a commit 3ae4a29

File tree

7 files changed

+388
-357
lines changed

7 files changed

+388
-357
lines changed

.github/workflows/mdbook.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ jobs:
3333
build:
3434
runs-on: ubuntu-latest
3535
env:
36-
MDBOOK_VERSION: 0.4.40
36+
MDBOOK_VERSION: 0.4.52
37+
MDBOOK_MERMAID_VERSION: 0.15.0
3738
steps:
3839
- uses: actions/checkout@v4
39-
- name: Install mdBook
40+
- name: Install mdBook + preprocessors
4041
run: |
4142
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
4243
rustup update
4344
cargo install --version ${MDBOOK_VERSION} mdbook
45+
cargo install --version ${MDBOOK_MERMAID_VERSION} mdbook-mermaid
4446
- uses: extractions/setup-just@v2
4547
- name: Setup Pages
4648
id: pages

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
book
22
target
33
.cache
4-
src/api
4+
src/api
5+
6+
# copied into the repo by `mdbook-mermaid` install:
7+
/mermaid*.js

0 commit comments

Comments
 (0)