/redactor

Documentation Quality Assurance Framework

Primary LanguageGoMIT LicenseMIT

Redactor

docs/_static/logo-small.png

A work in progress editor-in-chief to highlight potential linguistic and structural issues with your text.

Features

  • Check Markdown best practices
  • Spelling, Grammar, style and readability

Dependencies

Installation

Install it via curl:

curl https://raw.githubusercontent.com/testthedocs/redactor/master/install.sh | sh

Install via go get:

go get github.com/testthedocs/redactor

Documentation

You can find the HTML version online and the source on GitHub.

Contribute

Pull requests are welcome.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT