Skip to content
This repository has been archived by the owner on Dec 14, 2021. It is now read-only.

Latest commit

 

History

History
71 lines (47 loc) · 1.91 KB

README.md

File metadata and controls

71 lines (47 loc) · 1.91 KB

Medium Editor for Rails

Gem Version Code Climate Dependency Status

This gem integrates Medium Editor with Rails asset pipeline.

Version

The latest version of Medium Editor bundled by this gem is 5.23.2

Installation

Include medium-editor-rails in your Rails project's Gemfile:

gem 'medium-editor-rails'

And then execute:

bundle install

Configuration

Include javascript file in app/assets/javascripts/application.js:

//= require medium-editor

Include stylesheet file in app/assets/stylesheets/application.css:

*= require medium-editor/medium-editor

You can also include themes from themes folder, example:

*= require medium-editor/themes/flat

For more themes, visit: Medium Editor Themes

Using Medium Editor with Rails

You need to initialize Medium Editor with any selector of div, example:

<div class="editable"></div>

<script>
  var editor = new MediumEditor('.editable', {
    // options go here
  });
</script>

For extra options, visit: Medium Editor Options

Contributing

  1. Fork it ( http://github.com/marjinal1st/medium-editor-rails/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request