diff options
| author | Michael Bryan <michaelfbryan@gmail.com> | 2018-01-27 14:53:46 +0800 |
|---|---|---|
| committer | Niko Matsakis <niko@alum.mit.edu> | 2018-01-31 14:13:10 -0500 |
| commit | fa38aac34cb41e8698eb2e6e68693a5c104d0a8d (patch) | |
| tree | a008437302743088d2404fa5c79e869ca3a948db /src/doc/rustc-dev-guide | |
| parent | f48a68e481e2ce8eaf90f6471200569030102f3a (diff) | |
| download | rust-fa38aac34cb41e8698eb2e6e68693a5c104d0a8d.tar.gz rust-fa38aac34cb41e8698eb2e6e68693a5c104d0a8d.zip | |
Added a note about how to use mdbook-linkcheck
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md index 5ff51de2b73..352c4ce0ba5 100644 --- a/src/doc/rustc-dev-guide/README.md +++ b/src/doc/rustc-dev-guide/README.md @@ -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 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 +``` |