Contents

Markdown Toolbar
================

Markdown Toolbar is an lightweight helper buttons that appear over textarea

[![image](http://fuksito.com/markdown-toolbar-preview.png)](http://markdown-toolbar-example.herokuapp.com/)


Try a [demonstration](http://markdown-toolbar-example.herokuapp.com/)


Installation
------------

### Rails 4.1+

Use version 1.0.0

### Rails 3 and before 4.1

use version 0.2.4

In any rails version Add this to your Gemfile and run the **bundle** command.

    gem "markdown-toolbar"


Getting Started
---------------

Markdown Toolbar requires you to add such lines to your application.js

    //= require markdown-toolbar

and to application.css

    *= require markdown-toolbar

Then you can add toolbar to any textarea by adding a class **markdown-toolbar** to it

    <%= f.text_area :text, :class => "markdown-toolbar" %>

Alternatively, if you dynamicly create textareas, you can assign markdown toolbar in javascript by creating new instance of MarkdwonToolbar, with a textarea element as argument:

    new MarkdownToolbar($("#some_textarea"));

Customizing
-----------

You can customize order, remove or add new buttons by copying markdown-toolbar-buttons.js file into your project.
There is a rails generator to do it:

    rails generate markdown_toolbar:copy_buttons

To customize stylesheet run:

    rails generate markdown_toolbar:copy_css

License
-------

Markdown Toolbar is released under the [MIT License](http://www.opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
markdown-toolbar-1.0.0	README.markdown