emd

Embedded Markdown is created so that I can use markdown within my own rails projects.

Embedded Markdown uses a rails engine and a simple initializer to initiate a template handler for markdown using redcarpet.

Special thanks to these folks for making emd possible

Example repo

TODO

Installation

Add this two lines to your application's Gemfile:

gem 'redcarpet'
gem 'emd'

emd depends on redcarpet for markdown rendering

And then execute:

$ bundle

Or install it yourself as:

$ gem install emd

Usage

create a partial app/view/frontpages/_component.html.md

### This is a component

- This is item 1
- This is iiem 2
- [This is a link to google] (http://google.com)

Then, use this partial using <%= render "component" %> within any view like index.html.erb

Development

After checking out the repo, run bin/setup to install dependencies. 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/[USERNAME]/emd. 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.