Giter Club home page Giter Club logo

epiceditor's Introduction

EpicEditor for Rails

Gem Version Build Status Code Climate

EpicEditor for Rails - is a Ruby on Rails version of EpicEditor "An Embeddable JavaScript Markdown Editor", ready to drop right into your Rails 4 applications.

NOTE: EpicEditor for Rails version 0.2.2.1 simply adds EpicEditor to the asset pipeline. You can watch this repo to be notified when additional features are added. Additional customization is coming soon.

Installation

Add the following line to your Gemfile:

gem 'epiceditor', '~> 0.2.2'

bundle install and restart your server to make the files available.

Add the javascript file to app/assets/javascripts/application.js just above require_tree .

//= require epiceditor/epiceditor
//= require_tree .

In your application.css, include the css file:

/*
 *= require epiceditor
 */

If you prefer SCSS, add this to your application.css.scss file:

@import "epiceditor";

Mount the engine to your application by adding the following line to your config/routes.rb.

mount EpicEditor::Engine => "/"

Alternatively, if you only want EpicEditor to be available at a specific path change "/" to "/my_custom_path"

Bugs and Feature Requests

Have a bug or a feature request? Please open a new issue. Before opening an issue, please search for existing issues in this repo as well as the OscarGodson/EpicEditor repository.

Versioning

EpicEditor uses Semantic Versioning (ie: 0.2.2). EpicEditor for Rails version numbering will stay in sync with the EpicEditor version number, and be released in the form of 1.x.y.z, where 1.x.y is the release of EpicEditor, and z is the Rails patch version.

Troubleshooting

  • Verify the javascripts and stylesheets assets appear within your application's asset pipeline search path by running y Rails.application.config.assets.paths using rails console. You should see something similar to the following:

    .../epiceditor-0.2.2.1/vendor/assets/stylesheets
    .../epiceditor-0.2.2.1/vendor/assets/javascripts
    

Support

If you're having any problems with EpicEditor for Rails, feel free to open a new ticket. Go ahead and ask us anything and we'll try to help however we can. You can also see if there's someone available at the #epiceditor IRC channel on irc.freenode.net.

Who's Who?

EpicEditor for Rails is a project by AJ Acevedo
EpicEditor is a project by Oscar Godson

epiceditor's People

Contributors

aj-acevedo avatar caseybennington avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.