https://github.com/edmolima/frontmattergo

Simplifying YAML frontmatter unmarshalling in Go.
https://github.com/edmolima/frontmattergo

go parser yaml

Last synced: about 2 months ago
JSON representation

Simplifying YAML frontmatter unmarshalling in Go.

• Host: GitHub
• URL: https://github.com/edmolima/frontmattergo
• Owner: edmolima
• License: mit
• Created: 2024-01-20T12:06:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-21T11:12:24.000Z (over 2 years ago)
• Last Synced: 2025-03-28T14:44:18.466Z (about 1 year ago)
• Topics: go, parser, yaml
• Language: Go
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# frontmattergo

[![GoDoc](https://godoc.org/github.com/edmolima/frontmattergo?status.svg)](https://godoc.org/github.com/edmolima/frontmattergo)

![](https://img.shields.io/badge/status-stable-green.svg)

![](https://img.shields.io/badge/license-MIT-blue.svg)

`frontmattergo` is a Go package that provides a simple and efficient way to unmarshal YAML frontmatter from text content. Frontmatter is often used in Markdown files to include metadata or configuration at the beginning of the document.

Package `frontmattergo` provides YAML frontmatter unmarshalling for Go.

## Installation

```bash

go get -u github.com/edmolima/frontmattergo

```

## Features

- **YAML Frontmatter Unmarshalling:** Extract YAML frontmatter from text content seamlessly.

- **Efficient Parsing:** Designed for efficiency with minimal dependencies, using the YAML parsing capabilities of the `gopkg.in/yaml.v3` package.

- **Easy Integration:** Integrate with your existing Go projects effortlessly.

## Contributing

Thank you for considering contributing to `frontmattergo`! Contributions are welcome, and we appreciate your help in making this project better.

# Report Issues

If you find any issues or have suggestions, please open an issue on the GitHub repository. Provide a clear description of the problem and, if possible, a minimal reproducible example.

# License

By contributing to frontmattergo, you agree that your contributions will be licensed under the [MIT License](./LICENSE).