From d89ecf02aac3e695b36cf717540e85e03741d24a Mon Sep 17 00:00:00 2001 From: Camelid Date: Sun, 11 Oct 2020 11:43:26 -0700 Subject: [PATCH] Use official mdbook-linkcheck version We were using an alpha version before, pinned to a Git hash, so that we could access a new feature (Michael-F-Bryan/mdbook-linkcheck#42). Now there is a point release though (0.7.1), so we can update to that! --- .travis.yml | 2 +- README.md | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 395334e5..de1392e8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,7 +12,7 @@ before_install: install: - source ~/.cargo/env || true - cargo install mdbook --version '^0.4.3' -- cargo install mdbook-linkcheck --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev 14441d77646d58cea8ffc32fde9ea33b2bedb1a2 +- cargo install mdbook-linkcheck --version '^0.7.1' script: - git checkout -b ci - git rebase origin/master diff --git a/README.md b/README.md index 8b46b249..6bd2177e 100644 --- a/README.md +++ b/README.md @@ -100,11 +100,10 @@ New-Item -Path .git/hooks/pre-commit -ItemType HardLink -Value cargo install mdbook-linkcheck --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev 14441d77646d58cea8ffc32fde9ea33b2bedb1a2 +> cargo install mdbook-linkcheck ``` -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`. +You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.7.1` to check links. `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: @@ -118,7 +117,7 @@ error: The server responded with 429 Too Many Requests for "https://github.com/r │ ^ Server responded with 429 Too Many Requests ``` -There is not a workaround for this error at the moment. Comment out the `[output.linkcheck]` field in the `book.toml` using the build instructions above to complete a local site build without link validations. +There is not a workaround for this error at the moment. Comment out the `[output.linkcheck]` field in the `book.toml` using the build instructions above to complete a local site build without link validations. ## How to fix toolstate failures