✨ Add mermaid-js plugin to book

op-rs · Nov 24, 2023 · a9b3444 · a9b3444
1 parent 23d6a5d
commit a9b3444
Show file tree

Hide file tree

Showing 4 changed files with 1,295 additions and 3 deletions.
diff --git a/.github/workflows/book.yaml b/.github/workflows/book.yaml
@@ -14,11 +14,14 @@ jobs:
     steps:
       - name: Checkout sources
         uses: actions/checkout@v4
-      - name: Setup mdBook
+      - name: Setup mdbook
         uses: peaceiris/actions-mdbook@v1
         with:
-          mdbook-version: '0.4.10'
-          # mdbook-version: 'latest'
+          mdbook-version: 'latest'
+      - name: Setup mdbook-mermaid
+        uses: magicgh/mdbook-mermaid-action@v1
+        with:
+          version: 'latest'
       - name: Build book
         working-directory: ./book
         run: mdbook build

diff --git a/book/book.toml b/book/book.toml
@@ -4,3 +4,9 @@ language = "en"
 multilingual = false
 src = "src"
 title = "The Kona Book"
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
+[output.html]
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
diff --git a/book/mermaid-init.js b/book/mermaid-init.js
@@ -0,0 +1 @@
+mermaid.initialize({ startOnLoad: true, theme: 'dark' });
diff --git a/book/mermaid.min.js b/book/mermaid.min.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		mermaid.initialize({ startOnLoad: true, theme: 'dark' });