Popularity
2.1
Growing
Activity
5.3
Growing
30
2
0

Programming language: Go
License: MIT License

frontmatter alternatives and similar packages

Based on the "Utility" category.
Alternatively, view frontmatter alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of frontmatter or a related project?

Add another 'Utility' Package

README

frontmatter

Go library for detecting and decoding various content front matter formats.

Supported formats

The following front matter formats are supported by default. If the default formats are not suitable for your use case, you can easily bring your own. For more information, see the usage examples below.

Default front matter formats

Installation

go get github.com/adrg/frontmatter

Usage

Default usage.

package main

import (
    "fmt"
    "strings"

    "github.com/adrg/frontmatter"
)

var input = `
---
name: "frontmatter"
tags: ["go", "yaml", "json", "toml"]
---
rest of the content`

func main() {
    var matter struct {
        Name string   `yaml:"name"`
        Tags []string `yaml:"tags"`
    }

    rest, err := frontmatter.Parse(strings.NewReader(input), &matter)
    if err != nil {
        // Treat error.
    }
    // NOTE: If a front matter must be present in the input data, use
    //       frontmatter.MustParse instead.

    fmt.Printf("%+v\n", matter)
    fmt.Println(string(rest))

    // Output:
    // {Name:frontmatter Tags:[go yaml json toml]}
    // rest of the content
}

Bring your own formats.

package main

import (
    "fmt"
    "strings"

    "github.com/adrg/frontmatter"
    "gopkg.in/yaml.v2"
)

var input = `
...
name: "frontmatter"
tags: ["go", "yaml", "json", "toml"]
...
rest of the content`

func main() {
    var matter struct {
        Name string   `yaml:"name"`
        Tags []string `yaml:"tags"`
    }

    formats := []*frontmatter.Format{
        frontmatter.NewFormat("...", "...", yaml.Unmarshal),
    }

    rest, err := frontmatter.Parse(strings.NewReader(input), &matter, formats...)
    if err != nil {
        // Treat error.
    }
    // NOTE: If a front matter must be present in the input data, use
    //       frontmatter.MustParse instead.

    fmt.Printf("%+v\n", matter)
    fmt.Println(string(rest))

    // Output:
    // {Name:frontmatter Tags:[go yaml json toml]}
    // rest of the content
}

Full documentation can be found at: https://pkg.go.dev/github.com/adrg/frontmatter.

Stargazers over time

Stargazers over time

Contributing

Contributions in the form of pull requests, issues or just general feedback, are always welcome. See [CONTRIBUTING.MD](CONTRIBUTING.md).

License

Copyright (c) 2020 Adrian-George Bostan.

This project is licensed under the MIT license. See [LICENSE](LICENSE) for more details.


*Note that all licence references and agreements mentioned in the frontmatter README section above are relevant to that project's source code only.