fmatter

README

fmatter

A simple YAML Front Matter parser, using the gopkg.in/yaml.v2 package. View the godoc documentation here.

forked from james4k/fmatter:

• add go mod and tag v1.0.0

Documentation

Overview

Package fmatter is a simple YAML Front Matter parser, using the gopkg.in/yaml.v2 package.

Index

• func Read(data []byte, frontmatter interface{}) (content []byte, err error)
• func ReadFile(filename string, frontmatter interface{}) (content []byte, err error)

Examples

• Read

Functions

func Read

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

Read detects and parses the front matter data, and returns the remaining contents. If no front matter is found, the entire file contents are returned. For details on the frontmatter parameter, please see the gopkg.in/yaml.v2 package.

Example

data := []byte(`---
title: Some Title
---
content`)

var frontmatter struct{ Title string }
content, _ := Read(data, &frontmatter)
fmt.Println(content)

func ReadFile

func ReadFile(filename string, frontmatter interface{}) (content []byte, err error)

ReadFile read an entire file into memory, and calls Read which parses the front matter data and returns the remaining file contents.