Documentation Link Checker

.github/workflows/gh-page-unstable.yml

@@ -17,11 +17,14 @@ jobs:
         with:
           mdbook-version: 'latest'
 
+      - name: Install mdbook plugins
+        run: cargo install mdbook-linkcheck
+
       - run: mdbook build book
 
       - name: Publish book
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages-unstable
-          publish_dir: ./book/book
+          publish_dir: ./book/book/html

.github/workflows/gh-page.yml

@@ -17,10 +17,13 @@ jobs:
         with:
           mdbook-version: 'latest'
 
+      - name: Install mdbook plugins
+        run: cargo install mdbook-linkcheck
+
       - run: mdbook build book
 
       - name: Publish book
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./book/book
+          publish_dir: ./book/book/html

book/book.toml

@@ -7,4 +7,6 @@ src = "src"
 [output.html]
 cname = "halloy.squidowl.org"
 git-repository-url = "https://github.com/squidowl/halloy"
-edit-url-template = "https://github.com/squidowl/halloy/edit/main/book/{path}"
+edit-url-template = "https://github.com/squidowl/halloy/edit/main/book/{path}"
+
+[output.linkcheck]

book/src/configuration/buffer.md

@@ -554,7 +554,7 @@ Control if the text input should auto format the input. By default text is only
 auto_format = "markdown"
 ```
 
-> 💡 Read more about [text formatting](../../guides/text-formatting.html).
+> 💡 Read more about [text formatting](../guides/text-formatting.html).
 
 ### `[buffer.text_input.autocomplete]`
 

book/src/configuration/servers.md

@@ -9,7 +9,7 @@ Eg:
 # ...
 ```
 
-> 💡 For a multiple server example see [here](../../guides/multiple-servers.html)
+> 💡 For a multiple server example see [here](../guides/multiple-servers.html)
 
 ## `nickname`
 
@@ -368,7 +368,7 @@ who_poll_interval = 2
 
 A list of nicknames to [monitor](https://ircv3.net/specs/extensions/monitor) (if IRCv3 Monitor is supported by the server).
 
-> 💡 Read more about [monitoring users](../../guides/monitor-users.html).
+> 💡 Read more about [monitoring users](../guides/monitor-users.html).
 
 ```toml
 # Type: array of string

book/src/guides/getting-started.md

@@ -4,7 +4,7 @@ To get started with Halloy, you need to connect to at least one IRC server. The
 
 Once connected to a server, you can join channels. This can be done automatically from the config file or manually using the join command: `/join #channel`[^1]. To find channels, you can either use the list command: `/list`, or [browse for channels online](https://netsplit.de/channels/).
 
-> 💡 Configuration in Halloy happens through a `config.toml` file. See [Configuration](../configuration/index.html).
+> 💡 Configuration in Halloy happens through a `config.toml` file. See [Configuration](../configuration/).
 
 Here are a few useful IRC commands for a new user[^2]
 
@@ -18,4 +18,4 @@ Here are a few useful IRC commands for a new user[^2]
 
 
 [^1]: Channel names always start with a `#` symbol and do not contain spaces.
-[^2]: Find more commands [here](https://en.wikipedia.org/wiki/List_of_Internet_Relay_Chat_commands).
+[^2]: Find more commands [here](https://en.wikipedia.org/wiki/List_of_Internet_Relay_Chat_commands).

book/src/guides/multiple-servers.md

@@ -1,7 +1,7 @@
 # Multiple servers
 
 Creating multiple `[servers]` sections lets you connect to multiple servers.  
-All configuration options can be found [here](../configuration/servers/index.html).
+All configuration options can be found [here](../configuration/servers.html).
 
 ```toml
 [servers.liberachat]