ToMd

Convert Ruby Object to markdown by #to_md method.

Installation

Add this line to your application's Gemfile:

gem 'to_md'

And then execute:

$ bundle

Or install it yourself as:

$ gem install to_md

Usage

require 'to_md'

using ToMd

puts ['one', 'two'].to_md
# - one
# - two

puts [['#', 'japanese'], [1, '一']].to_md
# | # | japanese |
# | --- | --- |
# | 1 | 一 |

puts [{id: 1, name: 'John'}, {id: 2, name: 'David'}].to_md
# | id | name |
# | --- | --- |
# | 1 | John |
# | 2 | David |

puts [[:name, :age], {id: 3, name: 'Robert', age: 20}].to_md
# | name | age |
# | --- | --- |
# | Robert | 20 |

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/yasslab/to_md. 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

Copyright © 2015 YassLab

The gem is available as open source under the terms of the MIT License.