#mdbook #block #user #embed #visualization #rustviz #rust-viz

app mdbook-rustviz

An mdbook preprocessor that allows users to embed RustViz visualizations into mdbook projects

2 unstable releases

new 0.2.0 Oct 29, 2024
0.1.0 Oct 29, 2024

#437 in Text processing

Download history 244/week @ 2024-10-28

244 downloads per month

MIT license

30KB
600 lines

RustViz mdBook Preprocessor

A preprocessor to generate embedded RustViz diagrams in mdbook.

To install the preprocessor run: rustup run nightly-2024-05-20 cargo install mdbook-rustviz

Usage:

First, enable mdbook-rustviz in your mdBook's book.toml like so:

# book.toml
[preprocessor.rustviz]

Then add a RustViz code block to one of your Markdown source files like this:

```rv
fn main() {
  let mut s = String::from("hello");
  s.push_str(" world");
}
```

For extra debugging information, mdbook serve or mdbook build with RUST_LOG=info.

See test-book/ for an example

Dependencies

~15–26MB
~388K SLoC