Struct Markdown 

pub struct Markdown;

Renders processed citations and bibliography entries as CommonMark markup.

Trait Implementations

impl Clone for Markdown

fn clone(&self) -> Markdown

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Markdown

fn default() -> Markdown

Returns the “default value” for a type.

impl OutputFormat for Markdown

fn heading(&self, level: u8, content: Self::Output) -> Self::Output

Render a heading using ATX syntax (#, ##, …).

fn emph(&self, content: Self::Output) -> Self::Output

Render emphasis as *content* (CommonMark italic).

fn strong(&self, content: Self::Output) -> Self::Output

Render strong emphasis as **content** (CommonMark bold).

fn small_caps(&self, content: Self::Output) -> Self::Output

Render small caps as raw inline HTML.

CommonMark has no native small-caps syntax. Raw <span> HTML is passed through by Pandoc’s CommonMark reader and most other processors.

fn superscript(&self, content: Self::Output) -> Self::Output

Render superscript as raw inline HTML.

CommonMark has no native superscript syntax. Raw <sup> HTML is passed through by Pandoc and most processors.

fn semantic(&self, _class: &str, content: Self::Output) -> Self::Output

Render a semantic class as a plain passthrough.

CommonMark has no attribute syntax. Content is returned unchanged so citations remain readable plain text. Use --format html or --format djot if machine-readable semantic spans are needed.

fn visible_runs(&self, fragment: &str) -> Vec<Range<usize>>

Strip */** emphasis delimiters, <span>/<sup> raw-HTML wrappers, and a [content](url) link’s [/](url) markup — keeping link text visible but the URL hidden. A bracket pair not followed by (url) (i.e. from Self::wrap_punctuation’s WrapPunctuation::Brackets) keeps its brackets visible, since those are house-style punctuation. Backslash-escaped characters are visible as themselves.

type Output = String

The type used for intermediate rendered content.

fn text(&self, s: &str) -> Self::Output

Convert a raw string into the format’s output type.

fn join(&self, items: Vec<Self::Output>, delimiter: &str) -> Self::Output

Join multiple outputs into a single output using a delimiter.

fn finish(&self, output: Self::Output) -> String

Convert the intermediate output into the final result string.

fn quote(&self, content: Self::Output, marks: &QuoteMarks) -> Self::Output

Render content enclosed in outer quotation marks.

fn affix( &self, prefix: &str, content: Self::Output, suffix: &str, ) -> Self::Output

Apply outer prefix and suffix strings to the content.

fn inner_affix( &self, prefix: &str, content: Self::Output, suffix: &str, ) -> Self::Output

Apply inner prefix and suffix strings to the content.

fn wrap_punctuation( &self, wrap: &WrapPunctuation, content: Self::Output, marks: &QuoteMarks, script: ScriptClass, realization: Option<&PunctuationRealization>, ) -> Self::Output

Wrap the content in specific punctuation (parentheses, brackets, or quotes).

fn annotation(&self, content: Self::Output) -> Self::Output

Render an annotation block.

fn link(&self, url: &str, content: Self::Output) -> Self::Output

Hyperlink the content to a URL.

fn entry( &self, _id: &str, content: Self::Output, url: Option<&str>, _metadata: &ProcEntryMetadata, ) -> Self::Output

Render a single bibliography entry with its unique identifier and optional link.

fn quote_marks<'a>( &self, depth: usize, marks: &'a QuoteMarks, ) -> (&'a str, &'a str)

Return the opening and closing quote delimiters for a nesting depth.

fn quote_with_depth( &self, content: Self::Output, depth: usize, marks: &QuoteMarks, ) -> Self::Output

Render content enclosed in quotation marks at a specific nesting depth.

fn paragraph(&self, content: Self::Output) -> Self::Output

Render a paragraph block.

fn block_quote(&self, content: Self::Output) -> Self::Output

Render a block quotation.

fn bullet_list(&self, items: Vec<Self::Output>) -> Self::Output

Render an unordered (bullet) list from pre-rendered item strings.

fn ordered_list(&self, items: Vec<Self::Output>) -> Self::Output

Render an ordered (numbered) list from pre-rendered item strings.

fn list_item(&self, content: Self::Output) -> Self::Output

Render a list item.

fn unnumbered_heading(&self, level: u8, content: Self::Output) -> Self::Output

Render an unnumbered heading at the given level.

fn code_block(&self, _lang: Option<&str>, content: Self::Output) -> Self::Output

Render a fenced or indented code block with an optional language hint.

fn inline_code(&self, content: Self::Output) -> Self::Output

Render inline code.

fn strikeout(&self, content: Self::Output) -> Self::Output

Render strikethrough text.

fn hard_break(&self) -> Self::Output

Render a hard line break.

fn semantic_with_attributes( &self, class: &str, content: Self::Output, _attributes: &[SemanticAttribute], ) -> Self::Output

Apply a semantic identifier plus optional attributes to the content.

fn citation(&self, _ids: Vec<String>, content: Self::Output) -> Self::Output

Render a full citation container with one or more reference IDs.

fn visible_text<'a>(&self, fragment: &'a str) -> Cow<'a, str>

The visible (markup-stripped) text of a rendered fragment.

fn format_id(&self, id: &str) -> String

Format a reference ID for use as a target or link (e.g. adding a prefix).

fn bibliography(&self, entries: Vec<Self::Output>) -> Self::Output

Render a full bibliography container.