Expand description
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::{HeadingOffset, IdMap, Markdown, ErrorCodes};
let s = "My *markdown* _text_";
let mut id_map = IdMap::new();
let md = Markdown {
content: s,
links: &[],
ids: &mut id_map,
error_codes: ErrorCodes::Yes,
edition: Edition::Edition2015,
playground: &None,
heading_offset: HeadingOffset::H2,
};
let html = md.into_string();
// ... something using html
RunStructsยง
- CodeBlocks ๐Adds syntax highlighting and playground Run buttons to Rust code blocks.
- ExtraInfo ๐
- Footnotes ๐Moves all footnote definitions to the end and add back links to the references.
- HeadingLinks ๐Make headings links with anchor IDs and build up TOC.
- Indices ๐
- LangString ๐
- LinkReplacer ๐Make headings links with anchor IDs and build up TOC.
- When
to_string
is called, this struct will emit the HTML corresponding to the rendered version of the contained markdown string. - MarkdownItemInfo ๐A tuple struct like
Markdown
that renders the markdown escaping HTML tags and includes no paragraph tags. - MarkdownLink ๐
- MarkdownSummaryLine ๐A tuple struct like
Markdown
that renders only the first paragraph. - MarkdownWithToc ๐A struct like
Markdown
that renders the markdown with a table of contents. - MdRelLine ๐A newtype that represents a relative line number in Markdown.
- RustCodeBlock ๐
- SummaryLine ๐Extracts just the first paragraph.
- TableWrapper ๐Wrap HTML tables into
<div>
to prevent having the doc blocks width being too big. - TagIterator ๐This is the parser for fenced codeblocks attributes. It implements the following eBNF:
Enumsยง
- Ignore ๐
- LangStringToken ๐
- Line ๐Controls whether a line will be hidden or shown in HTML output.
- MarkdownLinkRange ๐
Constantsยง
- MAX_HEADER_LEVEL ๐
Staticsยง
- DEFAULT_ID_MAP ๐
Functionsยง
- check_if_allowed_tag ๐
- collect_link_data ๐Collects additional data of link.
- find_codes ๐
- find_testable_code ๐
- init_id_map ๐
- is_bareword_char ๐
- is_forbidden_tag ๐
- is_leading_char ๐
- is_separator ๐
- map_line ๐
- markdown_links ๐
- Renders a subset of Markdown in the first paragraph of the provided Markdown.
- plain_text_summary ๐Renders the first paragraph of the provided markdown as plain text. Useful for alt-text.
- rust_code_blocks ๐Returns a range of bytes for each code block in the markdown that is tagged as
rust
or untagged (and assumed to be rust). - Renders a shortened first paragraph of the given Markdown as a subset of Markdown, making it suitable for contexts like the search index.
- slugify ๐Convert chars from a title for an id.
- summary_opts ๐Options for rendering Markdown in summaries (e.g., in search results).
- main_body_opts ๐Options for rendering Markdown in the main body of documentation.
Type Aliasesยง
- SpannedEvent ๐