fmatter

Documentation

Index

• func Read(data []byte, frontmatter interface{}) []byte
• func ReadRaw(data []byte) (front, remaining []byte)
• func Write(frontmatter interface{}, content []byte) ([]byte, error)

Functions

func Read

func Read(data []byte, frontmatter interface{}) []byte

Read detects and parses data, and returns the front matter and the remaining contents. If no front matter is found, the entire file contents are returned.

func ReadRaw

func ReadRaw(data []byte) (front, remaining []byte)

ReadRaw detects and parses data, and returns the front matter and the remaining contents. If no front matter is found, the entire file contents are returned.

func Write

func Write(frontmatter interface{}, content []byte) ([]byte, error)

Write combine front matter and content, and returns the new bytes.