Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Add markdown preview to any text area in your rails app.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 app
Octocat-spinner-32 config
Octocat-spinner-32 lib
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 markdown_preview.gemspec
README.md

Markdown Preview for Rails

This gem gives you instant markdown preview for any textarea you want, anywhere in your application.

Installation

  1. Add to your Gemfile:

    gem 'markdown_preview'

  2. Include the assets where you want them

    //= require markdown_preview/base

  3. (Optional) If you want to override the preprocessor then add the following to config/initializers/markdown_preview.rb

    module MarkdownPreview
    
      #Write your own preprocessor here if you want to
      #the md param is the incoming markdown text, before it has been processed
      def self.preprocess_markdown( md )
        md 
      end
    
    end
    
  4. Add the markdown_preview class to any textareas you want to be previewable, and you're good to go!

    <textarea class="markdown_preview" id="my_awesome_textarea"></textarea>
    

Issues

https://github.com/jeffmcfadden/markdown_preview/issues

Credits

Jeff McFadden

Desiring God Ministries

Something went wrong with that request. Please try again.