Crate mdbook_boilerplate

Structs

Args

CmdPreprocessor

A custom preprocessor which will shell out to a 3rd-party program.

Report

The core error reporting type of the library, a wrapper around a dynamic error reporting type.

Enums

Error

Sub

Check whether a renderer is supported by this preprocessor

SupportedRenderer

Enum covering all supported renderers

Traits

Parser

Parse command-line arguments into Self.

Preprocessor

An operation which is run immediately after loading a book into memory and before it gets rendered.

Functions

asset_path

Determine the final assets path

fragment_path

Extract a temporary fragments path

get_config_value

Get a config value

launch

short_hash

Short hash. Useful in conjunction with chapter info.

Type Definitions

Result

type alias for Result<T, Report>

Table

Type representing a TOML table, payload of the Value::Table variant. By default it is backed by a BTreeMap, enable the preserve_order feature to use a LinkedHashMap instead.

Derive Macros

Parser

Generates the Parser implementation.