No commit activity in last 3 years
No release in over 3 years
A lightweight and minimal Ruby implementation of a Markdown renderer, designed with security in mind.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 3.8.0
 Project Readme

MinimalMarkdown

A lightweight and minimal Ruby implementation of a Markdown renderer, designed with security in mind.

Tiny codebase, no dependencies, and HTML is rendered from a tree so no possibility of corrupted or user-supplied HTML sneaking into the output.

Supported Markdown elements

  • Unordered lists
  • Bold
  • Italic
  • Paragraphs

Usage

Add to your Gemfile:

gem 'minimal_markdown'

Add to your app:

MinimalMarkdown.render('Here is my *markdown*')
=> "<div>Here is my <i>markdown</i></div>"

Or use the Slack-style Markdown parser by passing an option:

MinimalMarkdown.render('Here is my *markdown*', style: :slack)
=> "<div>Here is my <b>markdown</b></div>"