set up mdbook-linkcheck

Signed-off-by: Daniel Maslowski <info@orangecms.org>

Author: orangecms

.github/workflows/gh-pages.yml

@@ -24,6 +24,8 @@ jobs:
           mdbook-version: "0.4.48"
           use-mermaid: true
           mermaid-version: "0.15.0"
+          use-linkcheck: true
+          linkcheck-version: "0.7.7"
 
       - name: Install mdbook-mermaid
         run: mdbook-mermaid install

Makefile

@@ -4,7 +4,11 @@ build:
 run:
 	mdbook serve
 
+linkcheck:
+	mdbook-linkcheck
+
 prepare:
 	cargo install mdbook
 	cargo install mdbook-mermaid
 	mdbook-mermaid install
+	cargo install mdbook-linkcheck

README.md

@@ -18,6 +18,9 @@ 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).
 
+To check that all links are still available, [mdbook-linkcheck](
+https://github.com/Michael-F-Bryan/mdbook-linkcheck) also runs in CI.
+
 For convenience, the `Makefile` lets you set up and run the environment:
 
 ```sh

book.toml

@@ -10,6 +10,8 @@ cname = "book.linuxboot.org"
 git-repository-url = "https://github.com/linuxboot/book"
 additional-js = ["mermaid.min.js", "mermaid-init.js"]
 
+[output.linkcheck]
+
 [preprocessor]
 
 [preprocessor.mermaid]