No commit activity in last 3 years
No release in over 3 years
Makes it easy to use markdown with mongoid
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.12

Runtime

 Project Readme

mongoid_markdown

Code Climate Gem Version Build Status

Makes it easy to handle a field in a mongoid document that contains markdown.

Creates an extra method parsed_field_name which will return the HTML markup of the markdown.

Installation

Add this line to your application's Gemfile:

gem 'mongoid_markdown'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mongoid_markdown

Usage

  • Include MongoidMarkdown::Parser
  • Add field with markdown instead of the normal field
  • Enjoy the parsed_field_name method

Example:

class Article
  include Mongoid::Document
  include MongoidMarkdown::Parser

  field :header, type: String
  markdown :content
end

article = Article.new header: 'Check out mongoid_markdown', content: "Wow\n\n* list\n* *items*"
article.parsed_content # => "<p>Wow</p>\n\n<ul>\n<li>list</li>\n<li><em>items</em></li>\n</ul>\n"

Alternatives

mongoid-markdown, which takes a slightly different approach.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request