Skip to content

Manual: automated link checking using mdbook-linkcheck #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
4 commits merged into from
Aug 18, 2019
Merged

Manual: automated link checking using mdbook-linkcheck #61

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
43e97a5
travis.yml: add before_script instruction for mdbook and mdbook-linkc…
ngirard Aug 16, 2019
e3644fe
book.toml: add mdbook-linkcheck config options
ngirard Aug 16, 2019
628eead
Merge branch 'master' into ngirard-doc-autocheck
Aug 18, 2019
ed16f31
Update book.toml
Aug 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ env:

before_script:
- rustup component add rustfmt
- if [[ -n "$BUILD_DOCS" ]]; then (cargo install mdbook --force || true); fi
- if [[ -n "$BUILD_DOCS" ]]; then (cargo install mdbook-linkcheck --force || true); fi

matrix:
fast_finish: true
Expand Down
10 changes: 10 additions & 0 deletions docs/book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,13 @@ language = "en"
multilingual = false
src = "src"
title = "Async programming in Rust with async-std"


[output.linkcheck]
# Should we check links on the internet? Enabling this option adds a
# non-negligible performance impact
follow-web-links = false

# Are we allowed to link to files outside of the book's root directory? This
# may help prevent linking to sensitive files (e.g. "../../../../etc/shadow")
traverse-parent-directories = false