diff options
| author | GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com> | 2023-10-11 17:33:37 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-11 17:33:37 +0200 |
| commit | 8913b2fdcd92d9fc01e9e6086c8506d36b55bc2e (patch) | |
| tree | 66924433d1ae4a154f5626a06661f65528fba83f /README.md | |
| parent | 7d3cf3969ef2a9c4cd76d631667a2e7b4a3f5741 (diff) | |
| download | NorthstarWiki-8913b2fdcd92d9fc01e9e6086c8506d36b55bc2e.tar.gz NorthstarWiki-8913b2fdcd92d9fc01e9e6086c8506d36b55bc2e.zip | |
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
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -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) |