badascii-doc 0.4.0

Proc-macro to include BadASCII diagrams into your rustdoc output. Block diagrams in ASCII.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# BADASCII For RustDoc

Use `badascii` as a macro, and inject cool SVG diagrams into your
`rustdoc`, or wherever you might need them in your rust code.

Using it is super simple.

```shell
cargo add badascii-doc
```

And then in your code, simply use

```rust
#![doc = badascii!("
       +-------------+        +-------------+
       | Thing 1     |        | Thing 2     |
       |             |        |             |
  +--->|ins      outs+------->|ins      outs+----+
  |    |             |        |             |    |
  |    |             |        |             |    |
  |    +-------------+        +-------------+    |
  |                                              |
  +----------------------------------------------+
")]
```

And you will get a nice SVG rendering in your
generated markdown.  The SVG generated by these
macros is meant to be theme-agnostic.  They look
like this:

![SVG of diagram](https://raw.githubusercontent.com/samitbasu/badascii/refs/heads/main/badascii/example.svg)

If you prefer a more formal diagram use the 
`badascii_formal!` macro, which gives straight
lines and no backtalk.

If you are worried about compile time performance,
well, then you can use `badascii-cli` to process
the comments yourself and generate `svg` images.