Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nickserv/front_matter_document

A library for parsing and modifying front matter.
https://github.com/nickserv/front_matter_document

Last synced: 23 days ago
JSON representation

A library for parsing and modifying front matter.

Awesome Lists containing this project

README

        

# FrontMatterDocument
[![Build Status](https://travis-ci.org/nickmccurdy/front_matter_document.svg?branch=master)](https://travis-ci.org/nickmccurdy/front_matter_document)

A library for parsing and modifying front matter.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'front_matter_document'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install front_matter_document

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nickmccurdy/front_matter_document.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).