Skip to content

Commit 30d4a42

Browse files
LeSeulArtichautJoshua Nelson
authored and
Joshua Nelson
committed
Update installation instructions for mdbook-linkcheck
1 parent 50f1e77 commit 30d4a42

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

Diff for: README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,11 @@ New-Item -Path .git/hooks/pre-commit -ItemType HardLink -Value <absolute_path/to
100100
We use `mdbook-linkcheck` to validate URLs included in our documentation. To perform link checks, uncomment the `[output.linkcheck]` field in the `book.toml` configuration file and install `mdbook-linkcheck` with:
101101

102102
```bash
103-
> cargo install mdbook-linkcheck
103+
> cargo install mdbook-linkcheck --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev 14441d77646d58cea8ffc32fde9ea33b2bedb1a2
104104
```
105105

106-
You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.5` to check links.
106+
Note that we use an alpha version of `mdbook-linkcheck` to be able to use a feature that hasn't landed in a release yet.
107+
You will also need `mdbook` version `>= 0.3.5`.
107108
`linkcheck` will be run automatically when you build with the instructions in the section above.
108109

109110
**Please note**: You may receive errors like the following when link checks are active on local `mdbook` builds:

0 commit comments

Comments
 (0)