mdbook-regex

A Rust preprocessor for mdBook, replacing regular expression patterns with specified strings. Regex syntax is based on the Regex Rust crate.

Usage

Install the crate

cargo install mdbook-regex

Specify the patterns and string replacement in a .json file

[
    {
        "pattern" : "Your Pattern",
        "template" : "Your Template"
    }
]

Add the preprocessor to your book.toml file, and specify the path of the .json patterns file

[preprocessor.regex]
patterns = "path/to/patterns.json"

Example

The following pattern

[
    {
        "pattern" : "``collapse:(?P<title>([^\n])*)\n(?P<content>(?s:.)*)\n``",
        "template" : "<details>\n<summary>${title}</summary>\n<div class='collapsed'>\n${content}\n</div>\n</details>"
    }
]

allows the creation of collapsible regions, turning this

``collapse:Title
Content
``

into this

<details>
<summary>Title</summary>
<div class='collapsed'>
Content
</div>
</details>