frontmatter

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source
const (
	FieldTitle       = "title"
	FieldDescription = "description"
	FieldSlug        = "slug"
	FieldStatus      = "status"
)

Variables

View Source
var (
	PortalPageFields    = []string{FieldTitle, FieldDescription}
	PortalSnippetFields = []string{FieldTitle, FieldDescription}
	APIDocumentFields   = []string{FieldTitle, FieldSlug, FieldStatus}
)

Functions

This section is empty.

Types

type Metadata

type Metadata map[string]string

Metadata contains recognized scalar fields from a YAML frontmatter block.

func Parse

func Parse(content string, recognized []string) (Metadata, error)

Parse returns recognized scalar metadata from a leading YAML frontmatter block.

Jump to

Keyboard shortcuts

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