Wysihtml5-Enhanced bundled as a gem for Rails asset pipeline
Ruby Other
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
vendor/assets
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
wysihtml5n-rails.gemspec

README.md

Wysihtml5n-rails

This gem is a rails plugin that vendorizes the WysiHTML5-Enhanced Rich-Text editor for use with Rails asset pipeline.

You can learn more about WysiHTML5-Enhanced on Github

Installation

gem install wysihtml5n-rails

Usage

In your application.css (or any other Sprokets-enabled CSS file) add:

//= require wysihtml5n

Alternatively, if you're using SASS you can import wysihtml5n modules individually:

@import 'wysihtml5n/bootstrap';
@import 'wysihtml5n/editor';
@import 'wysihtml5n/font-awesome';

In your application.js (or any other Sprockets-enabled Javascript file) add:

//= require wysihtml5n

Or include the editor modules individually:

//= require wysihtml5n/jcrop
//= require wysihtml5n/wysihtml5-0.3.0
//= require wysihtml5n/wysihtml5-enhanced

Finally, initialize the editor:

$('.wysiwyg').wysiHTML5N();

You can pass options to editor

# use only some editor tools
$('.wysiwyg').wysiHTML5N({toolbar: ['h1', 'h2', 'h3', 'p', 'bold', 'italic']})

Font Awesome 3 vs 4

By default gem uses Font Awesome 3 (<i class="icon-bold"></i>).

To initialize editor with Font Awesome 4 icon style (<i class="fa fa-bold"></i>) :

$('.wysiwyg').wysiHTML5N({icon_style: 'font_awesome_4'})

Dependencies

Wysihtml5n-rails depends on:

  • jQuery
  • Rails 3.1+
  • SASS

The Twitter Bootstrap CSS file that's bundled with Wysihtml5n-rails only contains styles for forms and buttons. If you're already using Twitter Bootstrap in your application there's no need to require it again.