Module rustdoc::html::markdown [−] [src]

Unstable (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:

extern crate rustdoc; fn main() { use rustdoc::html::markdown::Markdown; let s = "My *markdown* _text_"; let html = format!("{}", Markdown(s)); // ... something using html }
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 fmt::Display trait implemented. When formatted, this struct will emit the HTML corresponding to the rendered version of the contained markdown string.
MarkdownWithToc [Unstable]

A unit struct like Markdown, that renders the markdown with a table of contents.

Statics

PLAYGROUND_KRATE [Unstable]

Functions

find_testable_code [Unstable]
plain_summary_line [Unstable]
render [Unstable]