Readme.md in pagedown-bootstrap-rails-1.1.0 vs Readme.md in pagedown-bootstrap-rails-2.0.0
- old
+ new
@@ -8,10 +8,12 @@
gem 'pagedown-bootstrap-rails'
In Rails 3.1 or Rails 3.2 this goes in the `:asset` group, but in Rails 4 it goes with the top level gems.
+You will also need Bootstrap and FontAwesome for PageDown Bootstrap Rails to work.
+
## Usage
Require the CSS with Sprockets:
/*= require pagedown_bootstrap */
@@ -27,26 +29,32 @@
Or individually as you please:
//= require markdown.converter
//= require markdown.editor
//= require markdown.sanitizer
+ //= require markdown.extra
-You will need to instantiate PageDown. I recommend a `lib/assets/javascripts/pagedown_init.js.coffee` that contains:
+You will need to instantiate PageDown and pagedown-bootstrap-rails comes with `pagedown_init` for you to optionally include:
$ ->
$('textarea.wmd-input').each (i, input) ->
attr = $(input).attr('id').split('wmd-input')[1]
converter = new Markdown.Converter()
Markdown.Extra.init(converter)
- editor = new Markdown.Editor(converter, attr)
+ help =
+ handler: () ->
+ window.open('http://daringfireball.net/projects/markdown/syntax')
+ return false
+ title: "<%= I18n.t('components.markdown_editor.help', default: 'Markdown Editing Help') %>"
+ editor = new Markdown.Editor(converter, attr, help)
editor.run()
-Require it with Sprockets:
+Just require it with Sprockets after `pagedown_bootstrap`:
//= require pagedown_bootstrap
//= require pagedown_init
-Then combine it with a new [SimpleForm](https://github.com/plataformatec/simple_form) input:
+I like to then use a new [SimpleForm](https://github.com/plataformatec/simple_form) input:
class PagedownInput < SimpleForm::Inputs::TextInput
def input
out = "<div id=\"wmd-button-bar-#{attribute_name}\"></div>\n"
out << "#{@builder.text_area(attribute_name, input_html_options.merge(