Crate mdbook_linkcheck[−][src]
Expand description
A 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
extract_links
) - 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
Structs
The configuration options available with this backend.
A wrapper around regex::Regex
which implements string repr based
Serialize
, Deserialize
, PartialEq
, Eq
, Hash
.
A potential link that has a broken reference (e.g [foo]
when there is no
[foo]: ...
entry at the bottom).
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.
Enums
How should warnings be treated?
Constants
A semver range specifying which versions of mdbook
this crate supports.
Functions
Search every file in the Files
and collate all the links that are
found.
Get the configuration used by mdbook-linkcheck
.
A helper for reading the chapters of a Book
into memory, filtering out
files using the given filter
.
Run the link checking pipeline.
Try to validate the provided Link
s.
Check whether this library is compatible with the provided version string.