frontmatter

package

v0.39.1 Latest Latest Go to latest Published: Aug 17, 2026 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hypnotox/agentic-workflows

Links

Open Source Insights

Documentation ¶

Overview ¶

Package frontmatter splits and parses YAML frontmatter delimited by leading "---" lines in markdown content. It is the single home for this concern.

Index ¶

func Parse(content []byte, out any) (body []byte, found bool, err error)
func ParseStrict(content []byte, out any) (body []byte, found bool, err error)
func Split(content []byte) (yamlBlock []byte, body []byte, found bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Parse ¶

func Parse(content []byte, out any) (body []byte, found bool, err error)

Parse splits frontmatter from content and unmarshals the YAML block into out. When no frontmatter is present, found is false and out is left unchanged.

func ParseStrict ¶ added in v0.34.0

func ParseStrict(content []byte, out any) (body []byte, found bool, err error)

ParseStrict is Parse with a closed mapping contract. It rejects fields that are not represented by out and rejects a second YAML document.

func Split ¶

func Split(content []byte) (yamlBlock []byte, body []byte, found bool)

Split separates a leading YAML frontmatter block (opened and closed by a line containing exactly "---") from the body. When content has no such block, found is false and body is the original content unchanged.

Types ¶

This section is empty.

Source Files ¶

View all Source files

frontmatter.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL