README.md

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 verification 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 (Wiki, Markdown, AsciiDoc, LaTeX, Re:VIEW, reStructuredText)
• Plugin system: users can write their extensions with JavaScript
• Annotation based error suppression
• Practical REST API and UI

Ecosystem

Tools

• Docker Image by Naoki Ainoya
• LaTeX RedPen Wercker Box by abcang
• RubyGem by akinomurasame
• Python Client

Editor packages

• Atom
  • redpen package by griffin-stewie
  • linter-redpen by griffin-stewie
• Emacs redpen-paragraph by karronoli
• Vim
  • unite.vim integration of redpen by rhysd
  • ALE (Vim linter plugin) redpen integration by rhysd
• WordPress plugin
• IntelliJ IDEA plugin
• SublimeLinter module for RedPen
• Visual Studio Code redpen-extension by takeo-asai

Extensions

• unsuggested-kanji by so-c
• ra-removed-word by ClearCode
• redpen-validator by kongou-ae

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 request. You can run test with the mvn test command. For details, please refer to the RedPen manual. Release flow is describe in this article

Deploy

Supports

• Mailing List
• Docs
• JavaDoc
• Blog
• Chat
  • English
  • Japanese

Acknowledgements

This project is supported by ATL.