Struct SurfDoc 

pub struct SurfDoc {
    pub front_matter: Option<FrontMatter>,
    pub blocks: Vec<Block>,
    pub source: String,
}

A parsed SurfDoc document.

Fields

front_matter: Option<FrontMatter>

Parsed YAML front matter, if present.

blocks: Vec<Block>

Ordered sequence of blocks in the document body.

source: String

Original source text that was parsed.

Implementations

impl SurfDoc

pub fn to_markdown(&self) -> String

Render this document as standard CommonMark markdown (no :: markers).

pub fn to_html(&self) -> String

Render this document as an HTML fragment with surfdoc-* CSS classes.

pub fn to_html_page(&self, config: &PageConfig) -> String

Render this document as a complete HTML page with SurfDoc discovery metadata.

pub fn to_terminal(&self) -> String

Render this document as ANSI-colored terminal text.

pub fn validate(&self) -> Vec<Diagnostic>

Validate this document and return any diagnostics.

Trait Implementations

impl Clone for SurfDoc

fn clone(&self) -> SurfDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfDoc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SurfDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SurfDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.