set up Mermaid integration

Co-authored-by: Philip Molloy <philip@philipmolloy.com>
Signed-off-by: Daniel Maslowski <info@orangecms.org>

Author: orangecms

.github/workflows/gh-pages.yml

@@ -18,10 +18,16 @@ jobs:
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v2
         with:
-          mdbook-version: '0.4.40'
+          mdbook-version: '0.4.48'
           # mdbook-version: 'latest'
 
-      - run: mdbook build
+      - name: Install mdbook-mermaid
+        run: |
+          cargo install mdbook-mermaid
+          mdbook-mermaid install
+
+      - name: Build
+        run: mdbook build
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

.gitignore

@@ -6,3 +6,4 @@ ci/vale/styles/Microsoft/
 ci/vale/styles/proselint/
 ci/vale/styles/RedHat/
 ci/vale/styles/write-good/
+*.js

Makefile

@@ -0,0 +1,10 @@
+build:
+	mdbook build
+
+run:
+	mdbook serve
+
+prepare:
+	cargo install mdbook
+	cargo install mdbook-mermaid
+	mdbook-mermaid install

README.md

@@ -15,6 +15,16 @@ This book is written with [mdBook](https://github.com/rust-lang/mdBook).
 When installed, run `mdbook serve` and you will get a local webserver.
 For more details, please refer to the mdBook documentation.
 
+Some pages render diagrams using [mermaid.js](https://mermaid.js.org/), which is
+preprocessed with [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid).
+
+For convenience, the `Makefile` lets you set up and run the environment:
+
+```sh
+make prepare
+make run
+```
+
 The book is linted with markdownlint and Vale. Follow the official
 documentation to [install
 markdownlint](https://github.com/markdownlint/markdownlint?tab=readme-ov-file#installation)

book.toml

@@ -8,3 +8,9 @@ title = "LinuxBoot"
 [output.html]
 cname = "book.linuxboot.org"
 git-repository-url = "https://github.com/linuxboot/book"
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
+
+[preprocessor]
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"