khaliyo / redpen

RedPen is an open source proofreading tool a tool to check if your technical documents meet the writing standard . RedPen supports various markup text formats (Markdown, Textile, AsciiDoc, and LaTeX).


Overview

RedPen is a proofreading tool to help writers or programmers who write technical documents or manuals that need to adhere to a writing standard. RedPen automates the verifications of input documents written in natural languages

See the detail usage in the RedPen home page.

Features

• Language Independent
• Highly customizable
• Multi platform (MacOS, Windows, and Linux)
• Support various markup text formats
• Plugin system: users can write their extensions with JavaScript
• Practical REST API and UI

Keywords

proofreading, document inspection, spellchecker, markup texts (Wiki, Markdown, AsciiDoc and LaTeX)

How to contribute

We welcome any contributions through Github pull requests. When you make changes such as adding new features and the tests, please run test before throw the pull reqest. You can run test with the mvn test command.

Links

• Mailing List
• Docs
• JavaDoc
• Blog
• Tools
  • Docker Image by Naoki Ainoya
  • RubyGem by akinomurasame
  • Python Client
  • Android App by Shintaro Katafuchi
• Editor pacakges
  • Atom Editor package by griffin-stewie
  • SublimeLinter module for RedPen
  • Emacs redpen-paragraph by karronoli
• Extensions
  • unsuggested-kanji by so-c
  • ra-removed-word by ClearCode

Deploy