Check for broken links on CI

Author: romac

.github/workflows/guide.yml

@@ -11,22 +11,28 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Setup mdBook
+      - name: Setup mdbook
         uses: peaceiris/actions-mdbook@v1
         with:
           mdbook-version: "0.4.6"
 
-      - name: Setup mdBook-mermaid
+      - name: Setup mdbook-mermaid
         uses: actions-rs/cargo@v1
         with:
           command: install
           args: mdbook-mermaid
 
+      - name: Setup mdbook-linkcheck
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: mdbook-linkcheck
+
       - run: |
           cd guide
           mdbook build
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./guide/book
+          publish_dir: ./guide/book

guide/book.toml

@@ -5,9 +5,10 @@ multilingual = false
 src = "src"
 title = "Hermes Documentation"
 
-[preprocessor]
 [preprocessor.mermaid]
 command = "mdbook-mermaid"
 
 [output.html]
 additional-js = ["mermaid.min.js", "mermaid-init.js"]
+
+[output.linkcheck]