add mdbook-mermaid

Author: nikomatsakis

.github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
     env:
       MDBOOK_VERSION: 0.4.12
       MDBOOK_LINKCHECK_VERSION: 0.7.2
+      MDBOOK_MERMAID_VERSION: 0.10.0
       MDBOOK_TOC_VERSION: 0.6.1
       DEPLOY_DIR: book/html
       BASE_SHA: ${{ github.event.pull_request.base.sha }}
@@ -31,7 +32,7 @@ jobs:
         with:
           path: |
             ~/.cargo/bin
-          key: ${{ runner.os }}-${{ env.MDBOOK_VERSION }}--${{ env.MDBOOK_LINKCHECK_VERSION }}--${{ env.MDBOOK_TOC_VERSION }}
+          key: ${{ runner.os }}-${{ env.MDBOOK_VERSION }}--${{ env.MDBOOK_LINKCHECK_VERSION }}--${{ env.MDBOOK_TOC_VERSION }}--${{ env.MDBOOK_MERMAID_VERSION }}
 
       - name: Cache linkcheck
         uses: actions/cache@v2
@@ -59,6 +60,7 @@ jobs:
           cargo install mdbook --version ${{ env.MDBOOK_VERSION }}
           cargo install mdbook-linkcheck --version ${{ env.MDBOOK_LINKCHECK_VERSION }}
           cargo install mdbook-toc --version ${{ env.MDBOOK_TOC_VERSION }}
+          cargo install mdbook-mermaid --version ${{ env.MDBOOK_MERMAID_VERSION }}
 
       - name: Check build
         run: mdbook build

book.toml

@@ -10,9 +10,13 @@ create-missing = false
 command = "mdbook-toc"
 renderer = ["html"]
 
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
 [output.html]
 git-repository-url = "https://github.com/rust-lang/rustc-dev-guide"
 edit-url-template = "https://github.com/rust-lang/rustc-dev-guide/tree/master/{path}?mode=edit"
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
 
 [output.html.fold]
 enable = true

mermaid-init.js

@@ -0,0 +1 @@
+mermaid.initialize({startOnLoad:true});