Summary

Transform html into markdown. Useful for example if you want to import html into your markdown based application.

Changelog

0.5.1 - April 2014

1. Adds support for ruby versions 1.9.3 back in
2. More options for handling of unknown tags
3. Bugfixes in li indentation behavior

0.5.0 - March 2014

There were some breaking changes, please make sure you don't miss them:

1. Only ruby versions 2.0.0 or above are supported
2. There is no Mapper class any more. Just use ReverseMarkdown.convert(input, options)
3. Config option github_style_code_blocks changed its name to github_flavored

Please open an issue and let me know about it if you have any trouble with the new version.

Requirements

1. Nokogiri
2. Ruby 1.9.3 or higher

Installation

Install the gem

[sudo] gem install reverse_markdown

or add it to your Gemfile

gem 'reverse_markdown'

Features

• Supports all the established html tags like h1, h2, h3, h4, h5, h6, p, em, strong, i, b, blockquote, code, img, a, hr, li, ol, ul, table, tr, th, td, br
• Module based - if you miss a tag, just add it
• Can deal with nested lists
• Inline and block code is supported
• Supports blockquote

Usage

Ruby

You can convert html content as string or Nokogiri document:

input  = '<strong>feelings</strong>'
result = ReverseMarkdown.convert input
result.inspect # " **feelings** "

Commandline

It's also possible to convert html files to markdown using the binary:

$ reverse_markdown file.html > file.md
$ cat file.html | reverse_markdown > file.md

Configuration

The following options are available:

• unknown_tags (default pass_through) - how to handle unknown tags. Valid options are:
  • pass_through - Include the unknown tag completely into the result
  • drop - Drop the unknown tag and its content
  • bypass - Ignore the unknown tag but try to convert its content
  • raise - Raise an error to let you know
• github_flavored (default false) - use github flavored markdown (yet only code blocks are supported)

As options

Just pass your chosen configuration options in after the input

ReverseMarkdown.convert(input, unknown_tags: :raise, github_flavored: true)

Preconfigure

Or configure it block style on a initializer level

ReverseMarkdown.config do |config|
  config.ignore_unknown_tags = false
  config.github_flavored     = true
end

Related stuff

• Write custom converters - Wiki entry about how to write your own converter
• html_massage - A gem by Harlan T. Wood to convert regular sites into markdown using reverse_markdown
• word-to-markdown - Convert word docs into markdown while using reverse_markdown, by Ben Balter
• markdown syntax - The markdown syntax specification
• github flavored markdown - Githubs extension to markdown
• wmd-editor - Markdown flavored text editor

Thanks

..to Ben Woosley for his improvements to the first version.

..to Harlan T. Wood for his help with the newer versions.

..and all contributors