Yet another Ruby wrapper for RedPen
Ruby JavaScript TeX Shell
Pull request Compare This branch is 9 commits ahead of akinomurasame:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
script
spec
.gitattributes
.gitignore
.rspec
.rubocop.yml
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
redpen.gemspec

README.md

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.