mdbook-regex 0.0.1

Mdbook preprocessor replacing regular expression patterns with specified strings.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

A Rust preprocessor for [mdBook](https://github.com/rust-lang/mdBook), replacing regular expression patterns with specified strings. Regex syntax is based on the [Regex](https://crates.io/crates/regex) Rust crate.

## Usage

Install the crate

```
cargo install mdbook-regex
```

Specify the patterns and string replacement in a `.json` file

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

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

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

## Example

For example, the following pattern

```json
[
    {
        "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

```text
``collapse:Title
Content
``
```

into this 

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