Search code examples
rustdoc

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


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>)


Solution

  • 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.