Wednesday, 9 March 2016

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

Changelog

Requirements

Install the gem

[sudo] gem install reverse_markdown

or add it to your Gemfile

gem 'reverse_markdown'

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

You can convert html content as string or Nokogiri document:

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

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

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)
tag_border (default ' ') - how to handle tag borders. valid options are: