frontmatter

Documentation

Overview

Package frontmatter provides a way of reading or writing Markdown or HTML files with a prepended frontmatter header in YAML or Protobuf Text.

Index

• func Marshal(w io.Writer, data interface{}, content string) error
• func Unmarshal(rd io.Reader, data interface{}) (string, error)

Functions

func Marshal

func Marshal(w io.Writer, data interface{}, content string) error

Marshal writes a frontmatter file with data in the header and content in the body. If data is a proto.Message it will use Protobuf Text, otherwise it will use a simple YAML serialization.

func Unmarshal

func Unmarshal(rd io.Reader, data interface{}) (string, error)

Unmarshal reads the input and parses the frontmatter into data returning the content. If data is a proto.Message it will use Protobuf Text, otherwise it will use YAML to read it.