Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redpen-cc/redpen

RedPen is an open source proofreading tool to check if your technical documents meet the writing standard. RedPen supports various markup text formats (Markdown, Textile, AsciiDoc, Re:VIEW, reStructuredText and LaTeX).
https://github.com/redpen-cc/redpen

asciidoc latex linter markdown proofreading restructuredtext wiki

Last synced: 13 days ago
JSON representation

Host: GitHub
URL: https://github.com/redpen-cc/redpen
Owner: redpen-cc
License: apache-2.0
Created: 2013-10-11T05:26:35.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2022-07-07T21:12:19.000Z (over 2 years ago)
Last Synced: 2024-08-01T17:32:34.601Z (3 months ago)
Topics: asciidoc, latex, linter, markdown, proofreading, restructuredtext, wiki
Language: Java
Homepage: https://redpen.cc
Size: 8.89 MB
Stars: 559
Watchers: 48
Forks: 74
Open Issues: 78
Metadata Files:
- Readme: README.md
- License: LICENSE-HEADER.txt

Awesome Lists containing this project

README

        [![Build Status](https://travis-ci.org/redpen-cc/redpen.svg?branch=master)](https://travis-ci.org/redpen-cc/redpen)

[![Coverage Status](https://coveralls.io/repos/recruit-tech/redpen/badge.png)](https://coveralls.io/r/recruit-tech/redpen)

[![Build status](https://ci.appveyor.com/api/projects/status/qtqmphigaip8lfwk?svg=true)](https://ci.appveyor.com/project/takahi-i/redpen)

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](https://redpen.cc/).

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](http://blog.redpen.cc/2015/09/08/writing-extension-with-javascript/)

- [Annotation based error suppression](https://blog.redpen.cc/2016/06/14/introduction-of-annotation-for-suppressing-errors-from-document-checking-tool-redpen/)

- [Practical REST API and UI](http://redpen.herokuapp.com/)



   



Ecosystem

==========

Tools

-----

  * [Docker Image by Naoki Ainoya](https://registry.hub.docker.com/u/ainoya/redpen-server/)

  * [LaTeX RedPen Wercker Box by abcang](https://hub.docker.com/r/abcang/latex-redpen-wercker-box/)

  * [RubyGem by akinomurasame](https://rubygems.org/gems/redpen_ruby)

  * [Python Client](https://pypi.python.org/pypi/pyredpen/)

Editor packages

---------------



   



  * Atom

    * [redpen package by griffin-stewie](https://atom.io/packages/redpen)

    * [linter-redpen by griffin-stewie](https://atom.io/packages/linter-redpen)

  * [Emacs redpen-paragraph by karronoli](https://libraries.io/emacs/redpen-paragraph/v0.2)

  * Vim

    * [unite.vim integration of redpen](https://github.com/rhysd/unite-redpen.vim) by [rhysd](https://github.com/rhysd)

    * [ALE (Vim linter plugin) redpen integration](https://github.com/w0rp/ale) by [rhysd](https://github.com/rhysd)

  * [WordPress plugin](https://github.com/redpen-cc/redpen-wordpress-plugin)

  * [IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/8210)

  * [SublimeLinter module for RedPen](https://github.com/taky/sublimelinter-redpen)

  * [Visual Studio Code redpen-extension by takeo-asai](https://marketplace.visualstudio.com/items?itemName=takeo-asai.redpen-extension)

Extensions

----------

  * [unsuggested-kanji](https://github.com/so-c/redpen-validator) by so-c

  * [ra-removed-word](http://www.clear-code.com/blog/2015/8/29.html) by ClearCode

  * [redpen-validator](https://github.com/kongou-ae/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](http://redpen.cc/docs/latest/#_for_developers). Release flow is describe in [this article](https://gist.github.com/takahi-i/32bbdb5814e076febed4)

Deploy

======

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

Supports

=========

* [Mailing List](https://groups.google.com/forum/#!forum/redpen-validator)

* [Docs](https://redpen.cc/docs.html)

* [JavaDoc](https://redpen.cc/javadoc/latest/index.html)

* [Blog](http://blog.redpen.cc)

* Chat

  * [English](https://gitter.im/redpen-cc/redpen)

  * [Japanese](https://gitter.im/redpen-cc/redpen/redpen-ja)

Acknowledgements

================

This project is supported by [ATL](http://atl.recruit-tech.co.jp/en/).