Minidown is a lightweight & fast markdown parser, with complete GFM support.
Latest commit 675e535 Jul 12, 2017
Failed to load latest commit information.
bin update banner Feb 23, 2014
lib just follow ruby version(2.1.1) :trollface: Feb 25, 2014
spec fix list nest regexp Feb 25, 2014
.gitignore first commit Aug 24, 2013
.travis.yml update travis Dec 26, 2013
Gemfile change name to minidown Aug 24, 2013
LICENSE.txt first commit Aug 24, 2013 Project Deprecated !!! Jul 12, 2017
Rakefile add specs Aug 24, 2013
minidown.gemspec update gem info Feb 23, 2014


Gem Version Build Status

Minidown is yet another markdown parser, with:

  • Complete GFM support.

  • Lightweight, no other dependencies.

  • Fast & easy to use.

Project Deprecated !!!

Please use kramdown instead


Add this line to your application's Gemfile:

gem 'minidown'

And then execute:

$ bundle

Or install it yourself as:

$ gem install minidown

Basic usage

require 'minidown'

#=> "<p><em>hello</em></p>"

Custom your own handler

highlight_with_pygments = ->(lang, content) {
  Pygments.highlight(content, :lexer => lang)

Minidown.render source, code_block_handler: highlight_with_pygments

# if you don't like pass options every time
parser_with_highlight = code_block_handler: highlight_with_pygments
parser_with_highlight.render source

Command line

minidown > result.html
open result.html

looks nice!


Complete GFM(GitHub Flavored Markdown) support. include Basic markdown, Task list, Table, Code, Blockquote etc.. view details


  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