feat: add support for mermaid (#6)

gear-tech · Dec 1, 2023 · 5d6a935 · 5d6a935
1 parent 8c3e464
commit 5d6a935
Show file tree

Hide file tree

Showing 5 changed files with 1,309 additions and 3 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -21,10 +21,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
+      - name: Install tools
+        uses: taiki-e/install-action@v2
         with:
-          mdbook-version: "0.4.35"
+          tool: mdbook,mdbook-mermaid
 
       - name: Build docs
         run: mdbook build

diff --git a/book.toml b/book.toml
@@ -4,3 +4,7 @@ authors = ["Gear Technologies"]
 
 [output.html]
 git-repository-url = "https://github.com/gear-tech/gear-tech.github.io"
+additional-js = ["js/mermaid.min.js", "js/mermaid-init.js"]
+
+[preprocessor]
+mermaid = { command = "mdbook-mermaid" }
diff --git a/js/mermaid-init.js b/js/mermaid-init.js
@@ -0,0 +1 @@
+mermaid.initialize({startOnLoad:true});
diff --git a/js/mermaid.min.js b/js/mermaid.min.js
diff --git a/src/gear-protocol/architechture-overview.md b/src/gear-protocol/architechture-overview.md
@@ -1,3 +1,22 @@
 # Architechture overview
 
+
+```mermaid
+flowchart TB
+    gear-cli-->vara-runtime
+    vara-runtime-->pallets
+    subgraph pallets
+        pallet-gear
+        pallet-gear-bank
+        pallet-gear-gas
+        pallet-gear-messenger
+        pallet-gear-program
+        pallet-gear-payment
+        pallet-gear-scheduler
+        pallet-gear-staking-rewards
+        pallet-gear-voucher
+    end
+
+```
+
 🚧 *To be added soon.*