frontparser

README

frontparser

a golang package for parsing frontmatter

Documentation

Index

• Variables
• func HasFrontmatterHeader(input []byte) bool
• func ParseFrontmatter(input []byte) (map[string]interface{}, error)
• func ParseFrontmatterAndContent(input []byte) (map[string]interface{}, []byte, error)
• func SplitFrontmatterAndContent(input []byte) ([]byte, []byte, error)

Variables

var ErrorFrontmatterNotFound error = errors.New("frontmatter header not found")

error messages

var FmYAMLDelimiter []byte = []byte("---")

Functions

func HasFrontmatterHeader

func HasFrontmatterHeader(input []byte) bool

returns whether the provided content contains a YAML frontmatter header

func ParseFrontmatter

func ParseFrontmatter(input []byte) (map[string]interface{}, error)

func ParseFrontmatterAndContent

func ParseFrontmatterAndContent(input []byte) (map[string]interface{}, []byte, error)

input is frontmatter + markdown return values - frontmatter - markdown - error

func SplitFrontmatterAndContent

func SplitFrontmatterAndContent(input []byte) ([]byte, []byte, error)