mdbook-rustviz

Crates.iomdbook-rustviz
lib.rsmdbook-rustviz
version0.2.0
sourcesrc
created_at2024-10-29 20:09:37.65893
updated_at2024-10-29 20:31:27.974971
descriptionAn mdbook preprocessor that allows users to embed RustViz visualizations into mdbook projects
homepage
repositoryhttps://github.com/rustviz/rustviz2
max_upload_size
id1427591
size86,112
Cyrus Omar (cyrus-)

documentation

README

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

Commit count: 97

cargo fmt