astro Architecture Docs
Home / Type/ ParseFrontmatterOptions Type — astro Architecture

ParseFrontmatterOptions Type — astro Architecture

Architecture documentation for the ParseFrontmatterOptions type/interface in frontmatter.ts from the astro codebase.

Type typescript

Entity Profile

Dependency Diagram

graph TD
  e72d2097_d8c7_0fde_92e0_25970c0f83e5["ParseFrontmatterOptions"]
  527bec49_26ec_0a56_3702_bf73cfac4e0b["frontmatter.ts"]
  e72d2097_d8c7_0fde_92e0_25970c0f83e5 -->|defined in| 527bec49_26ec_0a56_3702_bf73cfac4e0b
  style e72d2097_d8c7_0fde_92e0_25970c0f83e5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/markdown/remark/src/frontmatter.ts lines 27–38

export interface ParseFrontmatterOptions {
	/**
	 * How the frontmatter should be handled in the returned `content` string.
	 * - `preserve`: Keep the frontmatter.
	 * - `remove`: Remove the frontmatter.
	 * - `empty-with-spaces`: Replace the frontmatter with empty spaces. (preserves sourcemap line/col/offset)
	 * - `empty-with-lines`: Replace the frontmatter with empty line breaks. (preserves sourcemap line/col)
	 *
	 * @default 'remove'
	 */
	frontmatter: 'preserve' | 'remove' | 'empty-with-spaces' | 'empty-with-lines';
}

Defined In

Source

Frequently Asked Questions

What is the ParseFrontmatterOptions type?
ParseFrontmatterOptions is a type/interface in the astro codebase, defined in packages/markdown/remark/src/frontmatter.ts.
Where is ParseFrontmatterOptions defined?
ParseFrontmatterOptions is defined in packages/markdown/remark/src/frontmatter.ts at line 27.

Analyze Your Own Codebase

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

Try Supermodel Free