Struct MarkdownRenderResult 

pub struct MarkdownRenderResult {
    pub frontmatter: SimpleMetadata,
    pub frontmatter_error: Option<String>,
    pub headings: Vec<HeadingInfo>,
    pub html: String,
    pub outbound_links: Vec<OutboundLink>,
    pub has_h1: bool,
    pub word_count: usize,
    pub sentence_count: usize,
    pub syllable_count: usize,
    pub ambiguous_wikilinks: Vec<AmbiguousWikilink>,
    pub contact: Option<Contact>,
}

Result of rendering a markdown file to HTML.

Contains the rendered HTML along with metadata extracted during parsing.

Fields

frontmatter: SimpleMetadata

Frontmatter metadata (from YAML block at top of file)

frontmatter_error: Option<String>

YAML frontmatter parse error, if the metadata block failed to parse.

When Some, the whole frontmatter map was discarded (yaml-rust2 aborts the document on the first error), so valid fields are silently lost. Surfaced to the reader via the per-page errors endpoint and to the builder via a stderr summary.

headings: Vec<HeadingInfo>

Table of contents (headings extracted from document)

html: String

Rendered HTML content

outbound_links: Vec<OutboundLink>

Links discovered during rendering (for backlink tracking)

has_h1: bool

True if the document’s first heading is an H1 (affects title rendering)

word_count: usize

Word count of the document (excluding code blocks and metadata)

sentence_count: usize

Sentence count of the document (excluding code blocks and metadata).

Approximated by scanning for terminal punctuation (.!?) in text events, plus one-per-block for paragraphs, headings, and list items whose final text did not end in terminal punctuation.

syllable_count: usize

Syllable count of the document (excluding code blocks and metadata).

Computed via crate::readability::count_syllables for each whitespace-delimited word during rendering.

ambiguous_wikilinks: Vec<AmbiguousWikilink>

Bare body wikilinks whose name is shared by several notes, deduped.

Resolution is unchanged (first-wins); these are surfaced to the reader via the per-page errors endpoint so an accidental namesake link can be spotted. Always empty when the render had no wikilink index (CLI / QuickLook paths).

contact: Option<Contact>

The contact card model, for type: person / type: organization notes.

Parsed here, from the raw YAML, because the simplified frontmatter above has already lost list-of-map fields such as phones. Its image is rewritten with the same link transform the body’s images get, so a relative portrait resolves from the page’s trailing-slash URL.

Trait Implementations

impl Clone for MarkdownRenderResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownRenderResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.