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

Added a note about how to use mdbook-linkcheck

This commit is contained in:
Michael Bryan 2018-01-27 14:53:46 +08:00 committed by Niko Matsakis
parent a9a76280f4
commit b6105db8dc
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -25,3 +25,11 @@ for you to talk with someone who **does** know the code, or who wants
to pair with you and figure it out. Then you can work on writing up to pair with you and figure it out. Then you can work on writing up
what you learned. what you learned.
To help prevent accidentally introducing broken links, we use the
`mdbook-linkcheck`. If installed on your machine `mdbook` will automatically
invoke this link checker, otherwise it will emit a warning saying it couldn't
be found.
```
$ cargo install mdbook-linkcheck
```