jacobjzhang / emd

Embeddable markdown in Rails 5+ projects that don't suck 🍼

Embedded Markdown

Embedded Markdown uses a rails engine and a simple initializer to initiate a markdown template handler with the help of redcarpet.

The motivation is to reuse markdown in several of my Rails & Jekyll projects.

Special thanks to these folks for making emd possible

Benefits

1. Reuse markdown through out Rails and even Jekyll Projects
2. Allow copywriters & marketers to be involved in building your content easily
3. Allows you to focus on the content instead of the webpage structure.

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

Usage

A markdown view

1. Create a view called app/view/home/markdown.html.md and add the following sammple markdown.

       ## This is a sample markdown code
       - [google](http://google.com)
       - [emd](https://github.com/ytbryan/emd/)

2. Generate a home controller using the following command rails generate controller home

3. At route.rb, add the following line:

      get '/markdown', to: 'home#markdown'
   

4. Finally, visit the markdown view at http://localhost:3000/markdown

A markdown partial

1. Create a partial app/view/home/_component.html.md

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

2. 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/ytbryan/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.