Svgbob plugin for mdbook

Svgbob-based preprocessor for mdbook transform your ascii diagrams into a svg.

This renders a code-block marked bob into neat svg diagrams and inline it into the output.

Usage

Firstly add the following to your book's manifest file (usually book.toml)

toml [preprocessor.svgbob] # all fields by default See config for more information.

Add some ascii graphics:

chapter1.md_ md ```bob 0 3 *-------* +y 1 /| 2 /| ^ *-------* | | | |4 | |7 | ◄╮ | *-----|-* ⤹ +-----> +x |/ |/ / ⤴ *-------* v 5 6 +z ```

Build your book and open: mdbook build open book/index.html

Config

Default preprocessor config:

```toml [preprocessor.svgbob]

svgbob configuration:

doc: https://docs.rs/svgbob/latest/svgbob/struct.Settings.html

default values: https://github.com/ivanceras/svgbob/blob/master/packages/svgbob/src/settings.rs#L29-L38

fontsize = 14 fontfamily = "Iosevka Fixed, monospace" fillcolor = "black" background = "transparent" # default overridden, differs from svgbob's default strokecolor = "var(--fg)" # default overridden, differs from svgbob's default strokewidth = 2.0 scale = 8.0 enhancecircuitries = true includebackdrop = true includestyles = true includedefs = true mergelinewithshapes = false

preprocessor configuration:

code_block = "bob" # render only code-blocks marked as "bob", e.g.: bob

All properties are optional.

See svgbob's settings doc and default values.

For more information about mdbook see mdbook manual, svgbob spec and editor.

Contribution

Contributions are appreciated. Don't hesitate to participate to discussions in the issues, propose new features and ask for help.

Useful hint for one-command builds crate + book:

1. add command to the manifest:

```toml

book.toml

[preprocessor.svgbob] command = "cargo run --manifest-path /path/to/mdbook-svgbob/Cargo.toml --quiet" ```

1. So then you only need to rebuild the book. Run something like this:

bash RUST_LOG=mdbook_svgbob=trace mdbook build