Repository is archived
No commit activity in last 3 years
No release in over 3 years
A simple wrapper for markdown.js to play nice with the Rails asset pipeline.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0

Runtime

>= 3.1
 Project Readme

markdownjs-rails

⛔ [DEPRECATED]

markdownjs-rails wraps the markdown-js library for silky smooth use with the asset pipeline provided by Rails 3.1. The gem includes the development (non-minified) source for ease of exploration. The asset pipeline will handle minification in your production environment or if you set config.assets.debug = false in other environments.

I should also mention that markdown-js hasn't seen much active development in recent years - partially because it works pretty well - but if you're interested in using a JavaScript Markdown converter that's more actively maintained I recommend looking into Showdown. I've actually used both but in more recent projects I go with Showdown. And there's a similar Rails gem available here.

Installation

Add this line to your application's Gemfile:

gem 'markdownjs-rails'

Add the following directive to your Javascript manifest file (eg: application.js):

//= require markdown

Basic usage:

md_content = "Hello.\n\n* This is markdown.\n* It is fun\n* Love it or leave it."
html_content = markdown.toHTML( md_content );

And the complete documentation can be found on the markdonw-js readme.