mdbook backend which will check all links in a document are valid.
The link-checking process has roughly three stages:
- Find all the links in a body of markdown text (see
- Validate all the links we've found, taking into account cached results and configuration options
- Cache the results in the output directory for reuse by step 2 in the next round
- Emit errors/warnings to the user
The configuration options available with this backend.
A potential link that has a broken reference (e.g
An error that is emitted if something links to a file that exists on disk, but isn't included in the book.
The outcome of validating a set of links.
How should warnings be treated?
A semver range specifying which versions of
Search every file in the
Get the configuration used by
A helper for reading the chapters of a
Run the link checking pipeline.
Try to validate the provided
Check whether this library is compatible with the provided version string.