Crates.io | mdbook-rustviz |
lib.rs | mdbook-rustviz |
version | 0.2.0 |
source | src |
created_at | 2024-10-29 20:09:37.65893 |
updated_at | 2024-10-29 20:31:27.974971 |
description | An mdbook preprocessor that allows users to embed RustViz visualizations into mdbook projects |
homepage | |
repository | https://github.com/rustviz/rustviz2 |
max_upload_size | |
id | 1427591 |
size | 86,112 |
A preprocessor to generate embedded RustViz diagrams in mdbook.
To install the preprocessor run: rustup run nightly-2024-05-20 cargo install mdbook-rustviz
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