Redpen

Gem Version Build Status Code Climate

A Ruby wrapper for RedPen.

Requirements

  • Ruby
  • JDK8

Usage

require 'redpen'

config_file = './path/to/redpen-conf.xml'
target_file = './path/to/doc.md'

redpen = Redpen.check(config_file, target_file, format: 'markdown')

if redpen.valid?
  puts 'Ok, Valid!'
else
  puts redpen.messages
end

Install

Your Gemfile:

gem 'redpen'

License

This software is licensed under the same terms as Redpen.