Skip to content

Commit

Permalink
Document info-string option
Browse files Browse the repository at this point in the history
  • Loading branch information
Cypher1 committed Apr 28, 2024
1 parent 41457ac commit 1c15639
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,5 +133,22 @@ orders itself after `links`:
after = ["links"]
```

## Overriding the `info-string`

Some tools prefer a specific annotation for dot/graphviz diagrams.
For compatability with these tools `mdbook-graphviz` can support a custom value for marking diagrams it should process.
This is via the `info-string` flag:

```toml
[preprocessor.graphviz]
info-string = "graphviz"
```

or

```shell
MDBOOK_preprocessor__graphviz__info_string="graphviz" mdbook build
```

More information about preprocessors and ordering can be found
[here](https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html?highlight=preprocessors#require-a-certain-order).

0 comments on commit 1c15639

Please sign in to comment.