frontmatter

func ExtractYAMLFrontmatter ¶

func ExtractYAMLFrontmatter(ctx context.Context, r io.Reader) (content []byte, err error)

ExtractYAMLFrontmatter extracts YAML front matter content from r.

The extractor tries the known YAML front matter formats in order and returns only the extracted front matter bytes.

func NewYAML2FrontmatterFormat ¶

func NewYAML2FrontmatterFormat() *frontmatter.Format

NewYAML2FrontmatterFormat returns the alternative YAML front matter format using `---yaml` as the opening delimiter.

Source: https://github.com/adrg/frontmatter/tree/master

func NewYAMLDocumentEndFrontmatterFormat ¶ added in v1.161.1

func NewYAMLDocumentEndFrontmatterFormat() *frontmatter.Format

NewYAMLDocumentEndFrontmatterFormat returns the YAML front matter format that uses the YAML document end marker.

Source: https://yaml.org/spec/1.2.2/#912-document-markers

func NewYAMLFrontmatterFormat ¶

func NewYAMLFrontmatterFormat() *frontmatter.Format

NewYAMLFrontmatterFormat returns the YAML front matter format used by Hugo.

Source: https://gohugo.io/content-management/front-matter/

func UnmarshallYAMLFrontMatter ¶

func UnmarshallYAMLFrontMatter(ctx context.Context, r io.Reader, v any) (err error)

UnmarshallYAMLFrontMatter extracts YAML front matter from r and unmarshals it into v.