How to include ASCII art/diagrams in Rust source-code comment documentation?
Asked Answered
P

1

12

How should Markdown be used with rustdoc to include diagrams or ASCII art?

From reading the manual, triple back-ticks can be used for code-snippets. How do I include literal, non-formatted text?

(Something like Doxygen's <pre>...</pre>)

Poteet answered 11/11, 2016 at 15:0 Comment(0)
J
18

You use triple graves

```text
like this
```

Note the text. This tells rustdoc to not syntax highlight what's inside; the default is to think it's Rust code.

Judas answered 11/11, 2016 at 15:33 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.