Skip to main content

Module markdown

rustdoc::html

Module markdown 

Source
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 mut html = String::new();
md.write_into(&mut html).unwrap();
// ... something using html

Re-exports§

use std::borrow::Cow; 🔒
use std::collections::VecDeque; 🔒
use std::fmt; 🔒
use std::fmt::Write; 🔒
use std::iter::Peekable; 🔒
use std::ops::ControlFlow; 🔒
use std::ops::Range; 🔒
use std::path::PathBuf; 🔒
use std::str; 🔒
use std::str::CharIndices; 🔒
use std::sync::atomic::AtomicUsize; 🔒
use std::sync::Arc; 🔒
use std::sync::Weak; 🔒
use rustc_data_structures::fx::FxHashMap; 🔒
use rustc_data_structures::fx::FxIndexMap; 🔒
use rustc_errors::Diag; 🔒
use rustc_errors::DiagMessage; 🔒
use rustc_hir::def_id::LocalDefId; 🔒
use rustc_middle::ty::TyCtxt; 🔒
use rustc_resolve::rustdoc::pulldown_cmark; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::CodeBlockKind; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::CowStr; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::Event; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::LinkType; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::Options; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::Parser; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::Tag; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::TagEnd; 🔒
use rustc_resolve::rustdoc::pulldown_cmark::html; 🔒
use rustc_resolve::rustdoc::DocFragment; 🔒
use rustc_resolve::rustdoc::source_span_for_markdown_range; 🔒
use rustc_span::edition::Edition; 🔒
use rustc_span::Span; 🔒
use rustc_span::Symbol; 🔒
use tracing::debug; 🔒
use tracing::trace; 🔒
use crate::doctest; 🔒
use crate::doctest::GlobalTestOptions; 🔒
use crate::html::escape::Escape; 🔒
use crate::html::escape::EscapeBodyText; 🔒
use crate::html::highlight; 🔒
use crate::html::length_limit::HtmlWithLimit; 🔒
use crate::html::render::small_url_encode; 🔒
use crate::html::toc::Toc; 🔒
use crate::html::toc::TocBuilder; 🔒

Modules§

footnotes 🔒
Markdown footnote handling.

Structs§

CodeBlocks 🔒
Adds syntax highlighting and playground Run buttons to Rust code blocks.
CodeLineMapping 🔒
ExtraInfo 🔒
HeadingLinks 🔒
Make headings links with anchor IDs and build up TOC.
IdMap
Indices 🔒
LangString 🔒
LinkReplacer 🔒
LinkReplacerInner 🔒
Make headings links with anchor IDs and build up TOC.
Markdown
When to_string is called, this struct will emit the HTML corresponding to the rendered version of the contained markdown string.
MarkdownItemInfo 🔒
A 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.
Playground
RustCodeBlock 🔒
SpannedLinkReplacer 🔒
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.

Enums§

CodeBlockPosition 🔒
A type representing a position of a code block in Markdown.
ErrorCodes
HeadingOffset
Ignore 🔒
LangStringToken 🔒
Line 🔒
Controls whether a line will be hidden or shown in HTML output.
MarkdownLinkRange 🔒

Constants§

MAX_HEADER_LEVEL 🔒

Functions§

check_if_allowed_tag 🔒
find_codes 🔒
find_testable_code 🔒
html_text_from_events 🔒
is_bareword_char 🔒
is_default_id 🔒
is_forbidden_tag 🔒
is_leading_char 🔒
is_separator 🔒
map_code_block 🔒
map_line 🔒
This function is used to handle the “hidden lines” (ie starting with #) in doctests. It also transforms ## back into #.
markdown_links 🔒
markdown_range_for_code_range 🔒
markdown_summary_with_limit 🔒
Renders a subset of Markdown in the first paragraph of the provided Markdown.
plain_text_from_events 🔒
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).
short_markdown_summary 🔒
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 🔒