Crate mdbook_linkcheck

A mdbook backend which will check all links in a document are valid.

The link-checking process has roughly three stages:

1. Find all the links in a body of markdown text (see extract_links)
2. Validate all the links we’ve found, taking into account cached results and configuration options
3. Cache the results in the output directory for reuse by step 2 in the next round
4. Emit errors/warnings to the user

Structs

Config

The configuration options available with this backend.

Context

The linkcheck::validation::Context.

HashedRegex

A wrapper around regex::Regex which implements string repr based Serialize, Deserialize, PartialEq, Eq, Hash.

IncompleteLink

A potential link that has a broken reference (e.g [foo] when there is no [foo]: ... entry at the bottom).

NotInSummary

An error that is emitted if something links to a file that exists on disk, but isn’t included in the book.

ValidationOutcome

The outcome of validating a set of links.

Enums

WarningPolicy

How should warnings be treated?

Constants

COMPATIBLE_MDBOOK_VERSIONS

A semver range specifying which versions of mdbook this crate supports.

Functions

extract_links

Search every file in the Files and collate all the links that are found.

get_config

Get the configuration used by mdbook-linkcheck.

load_files_into_memory

A helper for reading the chapters of a Book into memory, filtering out files using the given filter.

run

Run the link checking pipeline.

validate

Try to validate the provided Links.

version_check

Check whether this library is compatible with the provided version string.