GitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.
289
stars
21
forks
source link
proposal: Add and enable mdbook-link check by default #495
Open
jzohrab opened 9 months ago
Checklist
Describe your proposal
Thank you for the helpful project!
Checking for broken links is such a common and necessary activity that adding default support for it would be super.
https://github.com/Michael-F-Bryan/mdbook-linkcheck#getting-started has a short script for getting a link checker.
Describe the solution you'd like
I think that all that would be needed would be for users to specify a step in their toml file:
At least on my machine, when I set up the link checker with the below script, everything runs as expected:
Describe alternatives you've considered
Perhaps a short link in the README to the link checker.
Additional context
Thank you very much!