Textile Editor Helper gem for Rails
Ruby Gherkin
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
features
lib
test
vendor
.coveralls.yml
.gitignore
CHANGELOG.md
Gemfile
README.md
Rakefile
textile_editor_helper.gemspec
travis.yml

README.md

Textile Editor Helper

Gem Version Build Status Code Climate Dependency Status Coverage Status

Textile Editor Helper is a plugin for Ruby on Rails to add a Textile toolbar above textareas.

This version of Textile Editor Helper is a fork of the code found at http://svn.webtest.wvu.edu/repos/rails/plugins/textile_editor_helper/ to allow for use with the form_for method.

Dependencies

To use Textile Editor Helper you must use the jQuery JavaScript library.

Follow best practices like adding JS files at the bottom of the page (before closing body tag).

Rails versions older than 4.1.4 are probably not supported by the current version. Ruby 1.8 is not supported.

If this broke something or you need to use it for an older version, please use:

gem 'textile_editor_helper', '0.0.31'

Otherwise, this should work:

gem 'textile_editor_helper', '0.1.4'

Rails Quickstart

Directions to get the helper up and running for your install:

First, you'll need to add the gems required. RedCloth (or an alterntative) and htmlentities are also required.

gem 'textile_editor_helper'
gem 'RedCloth'
gem 'htmlentities'

And run the following command:

rails g textile_editor_helper:install

It's important that you read the example provided. Your application.js should look like the following. Make sure to update the order of your JS files.

//= require jquery
//= require jquery_ujs
//= require textile-editor

To use the Textile Editor Helper with a specific text area, you can choose between the following options:

<%= f.textile_editor :description %>
<%= textile_editor :user, "website" %>
<%= textile_editor_tag 'description', :description %>

For simple_form users

<%= f.input :body, as: :textile_editor %>

For formtastic users

<%= f.input :body, as: :textile_editor %>

Just like writing a text area tag!

At the end of your form put in the following code:

<%= textile_editor_initialize %> **Important!**

Then, just save your view and check it out.

Examples

Basic Examples

Recently created a Rails 3.2.8 app that uses simple_form and textile_editor_helper, check it out.

Testing

git clone git://github.com/katgironpe/textile_editor_helper.git
cd textile_editor_helper
bundle install
bundle exec rake

Preview Feature

Textile Editor Preview feature is no longer supported. The wiki page will be updated to show two different ways of adding the preview feature to your app.

Requests for improvement

A lot of features have been removed and added here. This is completely refactored for simplicity and support of form builders other than the Rails default. To request for improvement, please do not send email to the maintainer. Create an issue instead. Thank you.

More Info on Textile

To learn more about Textile check out: Textism & Textile Reference

More Info on Slate

slate is the CMS in development at West Virginia University that led to the development of Textile Editor Helper. Learn more at: http://slateinfo.blogs.wvu.edu

License

Textile Editor Helper is released under the MIT license.

Acknowledgements

Textile Editor Helper was created by Dave Olsen (Javascript) and Chris Scharf (Ruby/Rails) of West Virginia University Web Services

The project is now maintained by Katherine G. Pe

Notes from maintainer

Due to some practical reasons, I am no longer using Textile as much as Markdown. I found this helpful before but no longer really use it. I still find time to maintain for those who do.

Inspired by

Patrick Woods & Alex King