Module rustdoc::html::markdown

Markdown formatting for rustdoc.

This module implements markdown formatting through the pulldown-cmark library.

#![feature(rustc_private)]

extern crate rustc_span;

use rustc_span::edition::Edition;
use rustdoc::html::markdown::{IdMap, Markdown, ErrorCodes};

let s = "My *markdown* _text_";
let mut id_map = IdMap::new();
let md = Markdown(s, &[], &mut id_map, ErrorCodes::Yes, Edition::Edition2015, &None);
let html = md.into_string();
// ... something using html

Structs

IdMap

Markdown

When to_string is called, this struct will emit the HTML corresponding to the rendered version of the contained markdown string.

Playground

Enums

ErrorCodes