Interface MarkdownInstance<T>

interface MarkdownInstance<T> {
    Content: AstroComponentFactory;
    default: AstroComponentFactory;
    file: string;
    frontmatter: T;
    url: undefined | string;
    compiledContent(): string;
    getHeadings(): MarkdownHeading[];
    rawContent(): string;
}

Type Parameters

Properties

Content default file frontmatter url

Methods

compiledContent getHeadings rawContent

Properties

Content

Content: AstroComponentFactory

Component to render content in .astro files. Usage: <Content />

default

default: AstroComponentFactory

file

file: string

Absolute file path (e.g. /home/user/projects/.../file.md)

frontmatter

frontmatter: T

url

url: undefined | string

Browser URL for files under /src/pages (e.g. /en/guides/markdown-content)

Methods

compiledContent

  • compiledContent(): string

  • Markdown file compiled to HTML, excluding layout HTML

    Returns string

getHeadings

  • getHeadings(): MarkdownHeading[]

  • List of headings (h1 -> h6) with associated metadata

    Returns MarkdownHeading[]

rawContent

  • rawContent(): string

  • raw Markdown file content, excluding layout HTML and YAML frontmatter

    Returns string

Settings

Member Visibility

Theme

On This Page

ContentdefaultfilefrontmatterurlcompiledContentgetHeadingsrawContent