0.06
No commit activity in last 3 years
No release in over 3 years
A wysiwyg text editor for Rails assets pipeline
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.3
~> 0

Runtime

>= 3.1.0
 Project Readme

wysihtml for Rails

Voog/wysihtml is an extended and less strict approach on xing/wysihtml5 open source rich text editor based on HTML5 technology.

This gem adds wysihtml to Rails assets pipeline.

Installation

Add this line to your application's Gemfile:

gem 'wysihtml-rails'

Or you can install from latest build:

gem 'wysihtml-rails', :git => 'https://github.com/Voog/wysihtml-rails.git'

And then execute:

bundle

Or install it yourself as:

$ gem install wysihtml-rails

Usage

Require it in your JS manifest's file application.js:

//= require wysihtml

or if you also need toolbar, table editing features or all commands:

//= require wysihtml
//= require wysihtml/toolbar
//= require wysihtml/all_commands
//= require wysihtml/table_editing

Additionally include predefined simple, advanced or advanced_unwrap parsing rules in your application.js:

//= require wysihtml/parser_rules/advanced_unwrap

Additionally include predefined wysihtml stiles in your application.css.scss file:

*= require wysihtml

The simple initialise:

<script>
   var editor = new wysihtml.Editor("wysihtml-textarea", { // id of textarea element
      toolbar:      "wysihtml-toolbar", // id of toolbar element
      stylesheets:  "<%= stylesheet_path('wysihtml') %>", // optional, css to style the editor's content
      parserRules:  wysihtmlParserRules, // defined in parser rules set
      //showToolbarAfterInit: false
   });
</script>

Contributing

  1. Fork it
  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