Module rustdoc::html::markdown
[−]
[src]
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::String. Example usage:
use rustdoc::html::markdown::Markdown; let s = "My *markdown* _text_"; let html = format!("{}", Markdown(s)); // ... something using html
Structs
| Markdown |
[Unstable] A unit struct which has the |
| MarkdownWithToc |
[Unstable] A unit struct like |
Statics
| PLAYGROUND_KRATE | [Unstable] |
Functions
| find_testable_code | [Unstable] |
| plain_summary_line | [Unstable] |
| render | [Unstable] |
| reset_headers |
[Unstable] By default this markdown renderer generates anchors for each header in the rendered document. The anchor name is the contents of the header separated by hyphens, and a thread-local map is used to disambiguate among duplicate headers (numbers are appended). |