From 8913b2fdcd92d9fc01e9e6086c8506d36b55bc2e Mon Sep 17 00:00:00 2001
From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
Date: Wed, 11 Oct 2023 17:33:37 +0200
Subject: Add instructions for running mdbook linkcheck (#238)

* Update config to support linkcheck

Allows checking if all relative links inside the mdBook are valid.
Especially useful for ensuring updated links when moving content around.


* Add section explaining link check to readme
---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index a5b2c9d..bf47242 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,12 @@ To install mdBook use the following link if:
 
 - [you have Rust toolchain installed](https://rust-lang.github.io/mdBook/guide/installation.html#build-from-source-using-rust)
 - [you **DON'T** have Rust toolchain installed](https://rust-lang.github.io/mdBook/guide/installation.html#pre-compiled-binaries)
+
+#### mdBook-linkcheck
+Additionally there's a community-made package that you can use alongside mdBook to show you some potentially broken links in markdown files called [mdBook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck)
+
+Although not required, you may find it helpful to use alongside mdBook to ensure you've linked things properly
+
+To install mdBook-linkcheck use the following link if:
+- [you have Rust toolchain installed](https://github.com/Michael-F-Bryan/mdbook-linkcheck#getting-started)
+- [you DON'T have Rust toolchain installed](https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/latest) (add `mdBook-linkcheck.exe` to the same folder `mdBook.exe` is located)
-- 
cgit v1.2.3