astro Architecture Docs
Home / Type/ MarkdownInstance Type — astro Architecture

MarkdownInstance Type — astro Architecture

Architecture documentation for the MarkdownInstance type/interface in content.ts from the astro codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  d3a4500e_cb51_a721_67a7_acb575241536["MarkdownInstance"]
  7547ecbb_58ef_bc2d_b119_f58ad78d86f6["content.ts"]
  d3a4500e_cb51_a721_67a7_acb575241536 -->|defined in| 7547ecbb_58ef_bc2d_b119_f58ad78d86f6
  style d3a4500e_cb51_a721_67a7_acb575241536 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/types/public/content.ts lines 14–29

export interface MarkdownInstance<T extends Record<string, any>> {
	frontmatter: T;
	/** Absolute file path (e.g. `/home/user/projects/.../file.md`) */
	file: string;
	/** Browser URL for files under `/src/pages` (e.g. `/en/guides/markdown-content`) */
	url: string | undefined;
	/** Component to render content in `.astro` files. Usage: `<Content />` */
	Content: AstroComponentFactory;
	/** raw Markdown file content, excluding layout HTML and YAML frontmatter */
	rawContent(): string;
	/** Markdown file compiled to HTML, excluding layout HTML */
	compiledContent(): Promise<string>;
	/** List of headings (h1 -> h6) with associated metadata */
	getHeadings(): MarkdownHeading[];
	default: AstroComponentFactory;
}

Defined In

Source

Frequently Asked Questions

What is the MarkdownInstance type?
MarkdownInstance is a type/interface in the astro codebase, defined in packages/astro/src/types/public/content.ts.
Where is MarkdownInstance defined?
MarkdownInstance is defined in packages/astro/src/types/public/content.ts at line 14.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free