frontmatter

package module

v1.0.0 Latest Latest Go to latest Published: Sep 9, 2019 License: MIT Imports: 4 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lucacasonato/frontmatter

Links

Open Source Insights

README ¶

frontmatter

Handle frontmatter in files.

example

data, rest, err := frontmatter.Parse(strings.NewReader(`---
name: frontmatter
version: 1.0.0
---

# hello
hello world!`), "---")

/*
data == `name: frontmatter
version: 1.0.0`
*/

/*
rest == `# hello
hello world!`
*/

licence

MIT. More in LICENCE file

Documentation ¶

Index ¶

Variables
func Parse(reader io.Reader, delimiter string) (frontmatter string, rest string, err error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrMissingDelimiter = errors.New("frontmatter: missing delimiter")

ErrMissingDelimiter is the error for when a reader does not contain 2 delimiters

Functions ¶

func Parse ¶

func Parse(reader io.Reader, delimiter string) (frontmatter string, rest string, err error)

Parse data into frontmatter and rest

Types ¶

This section is empty.

Source Files ¶

View all Source files

frontmatter.go

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