diff options
| author | LeSeulArtichaut <leseulartichaut@gmail.com> | 2020-10-10 18:35:25 +0200 |
|---|---|---|
| committer | Joshua Nelson <joshua@yottadb.com> | 2020-10-10 12:39:19 -0400 |
| commit | 7a5a10e20315f03a60fcf651fb9e497272c14523 (patch) | |
| tree | 6ecb6868528ffde8d400b92d48564eefbe7c3d8d /src/doc/rustc-dev-guide/README.md | |
| parent | 885badd57acc9b242e67c369894cf2124f5de70a (diff) | |
| download | rust-7a5a10e20315f03a60fcf651fb9e497272c14523.tar.gz rust-7a5a10e20315f03a60fcf651fb9e497272c14523.zip | |
Update installation instructions for `mdbook-linkcheck`
Diffstat (limited to 'src/doc/rustc-dev-guide/README.md')
| -rw-r--r-- | src/doc/rustc-dev-guide/README.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md index aab497af30c..8b46b249ce5 100644 --- a/src/doc/rustc-dev-guide/README.md +++ b/src/doc/rustc-dev-guide/README.md @@ -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: |