Module rustdoc::html::markdown
[−]
[src]
🔬 This is a nightly-only experimental API. (
rustdoc
)Markdown formatting for rustdoc
This module implements markdown formatting through the hoedown C-library
(bundled into the rust runtime). This module self-contains the C bindings
and necessary legwork to render markdown, and exposes all of the
functionality through a unit-struct, Markdown
, which has an implementation
of fmt::Display
. Example usage:
use rustdoc::html::markdown::Markdown; let s = "My *markdown* _text_"; let html = format!("{}", Markdown(s)); // ... something using htmlRun
Structs
Markdown |
[ Experimental ] A unit struct which has the |
MarkdownHtml |
[ Experimental ] A unit struct like |
MarkdownWithToc |
[ Experimental ] A unit struct like |
Statics
PLAYGROUND |
[ Experimental ]
|
Functions
find_testable_code |
[ Experimental ]
|
plain_summary_line |
[ Experimental ]
|
render |
[ Experimental ]
|