Skip to content

Commit 60808ea

Browse files
camelidJoshua Nelson
authored andcommitted
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!
1 parent 30d4a42 commit 60808ea

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ before_install:
1212
install:
1313
- source ~/.cargo/env || true
1414
- cargo install mdbook --version '^0.4.3'
15-
- cargo install mdbook-linkcheck --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev 14441d77646d58cea8ffc32fde9ea33b2bedb1a2
15+
- cargo install mdbook-linkcheck --version '^0.7.1'
1616
script:
1717
- git checkout -b ci
1818
- git rebase origin/master

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,10 @@ New-Item -Path .git/hooks/pre-commit -ItemType HardLink -Value <absolute_path/to
100100
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:
101101

102102
```bash
103-
> cargo install mdbook-linkcheck --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev 14441d77646d58cea8ffc32fde9ea33b2bedb1a2
103+
> cargo install mdbook-linkcheck
104104
```
105105

106-
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.
107-
You will also need `mdbook` version `>= 0.3.5`.
106+
You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.7.1` to check links.
108107
`linkcheck` will be run automatically when you build with the instructions in the section above.
109108

110109
**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
118117
│ ^ Server responded with 429 Too Many Requests
119118
```
120119

121-
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.
120+
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.
122121

123122

124123
## How to fix toolstate failures

0 commit comments

Comments
 (0)