mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update installation instructions for `mdbook-linkcheck`

This commit is contained in:
LeSeulArtichaut 2020-10-10 18:35:25 +02:00 committed by Joshua Nelson
parent 66649d9c81
commit f3de6c7166
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -100,10 +100,11 @@ New-Item -Path .git/hooks/pre-commit -ItemType HardLink -Value <absolute_path/to
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:
```bash
> cargo install mdbook-linkcheck
> cargo install mdbook-linkcheck --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev 14441d77646d58cea8ffc32fde9ea33b2bedb1a2
```
You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.5` to check links.
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.
You will also need `mdbook` version `>= 0.3.5`.
`linkcheck` will be run automatically when you build with the instructions in the section above.
**Please note**: You may receive errors like the following when link checks are active on local `mdbook` builds: