Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chris-huxtable/front_matter.cr
Separates a files front matter from its content
https://github.com/chris-huxtable/front_matter.cr
crystal crystal-lang crystal-language crystal-shard front-matter frontmatter shards
Last synced: about 2 months ago
JSON representation
Separates a files front matter from its content
- Host: GitHub
- URL: https://github.com/chris-huxtable/front_matter.cr
- Owner: chris-huxtable
- License: isc
- Created: 2018-05-01T00:25:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-01T01:47:37.000Z (almost 3 years ago)
- Last Synced: 2024-02-01T15:51:19.480Z (5 months ago)
- Topics: crystal, crystal-lang, crystal-language, crystal-shard, front-matter, frontmatter, shards
- Language: Crystal
- Size: 29.3 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-crystal - front_matter.cr - Separates a files front matter from its content (Data Formats)
- awesome-crystal - front_matter.cr - Separates a files front matter from its content (Data Formats)
- awesome-crystal - front_matter.cr - Separates a files front matter from its content (Data Formats)
README
# front_matter.cr
[](https://chris-huxtable.github.io/front_matter.cr/)
[](https://github.com/chris-huxtable/front_matter.cr/releases)
[](https://travis-ci.org/chris-huxtable/front_matter.cr)
Separates a files front matter from its content. Unlike Jekyll and others this implementation is format agnostic.
## Front Matter?
Front matter is metadata you can add to a document. The data is located between a pair of `---` lines at the start of a document. With this parser the format can be any format you would like.
```
---
The front matter
---
The content
```
A more practical and complicated example using YAML front matter with Liquid to generate some HTMLc ould look like below.
```
---
layout: post
title: Blogging Like a Hacker
---
{{ title }}
This is the content.
```
One of the most common, but not the only, uses for front matter is to use this with [Liquid](https://shopify.github.io/liquid/) ([crystal implementation](https://github.com/wmoxam/liquid-crystal)), or a similar templating language.
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
front_matter:
github: chris-huxtable/front_matter.cr
```
## Usage
```crystal
require "front_matter"
```
To process a file:
```crystal
FrontMatter.open("/path/to/file") { |front_matter, content_io|
# Do something with the front matter and content.
# Parse the front matter as YAML, JSON or something else?
}
```
Alternatively you can parse an `IO` so long as it supports the `#.seek` method
```crystal
File.open(filename, "r") { |fd|
FrontMatter.parse(fd) { |front_matter, content_io|
# Do something with the front matter and content.
# Parse the front matter as YAML, JSON or something else?
}
}
```
## Contributing
1. Fork it ( https://github.com/chris-huxtable/front_matter.cr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [Chris Huxtable](https://github.com/chris-huxtable) - creator, maintainer