Grokdown
Grok Markdown documents with Ruby objects. Have fun using whats inside Markdown documents, without all of the pain of walking a document tree.
Grok
- to understand intuitively or by empathy, to establish rapport with
- to empathize or communicate sympathetically (with); also, to experience enjoyment
Markdown
Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
Installation
Add this line to your application's Gemfile:
gem 'grokdown'
And then execute:
$ bundle
Or install it yourself as:
$ gem install grokdown
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/trykinside/grokdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Grokdown project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.