MarkdownFile

Type Alias MarkdownFile 

Source
pub type MarkdownFile = MarkdownDocument;
Expand description

Type alias for MarkdownDocument for backward compatibility.

This alias exists to provide a consistent naming convention and maintain backward compatibility with existing code that might use MarkdownFile. New code should prefer using MarkdownDocument directly.

§Examples

// These are equivalent
let doc1 = MarkdownDocument::new("content".to_string());
let doc2 = MarkdownFile::new("content".to_string());

assert_eq!(doc1.content, doc2.content);

Aliased Type§

pub struct MarkdownFile {
    pub metadata: Option<MarkdownMetadata>,
    pub content: String,
    pub raw: String,
}

Fields§

§metadata: Option<MarkdownMetadata>

Parsed metadata extracted from frontmatter.

This will be Some if the document contained valid YAML or TOML frontmatter, and None for plain Markdown files. The metadata is used by AGPM for dependency resolution and resource management.

§content: String

The main Markdown content without frontmatter delimiters.

This contains only the actual content portion of the document, with frontmatter stripped away. This is what gets processed for content-based metadata extraction.

§raw: String

The complete original document including frontmatter.

This field preserves the exact original format for faithful reproduction when writing back to disk. When metadata or content is modified, this field is automatically regenerated to maintain consistency.