<p align="center">
  <img alt="Redactor Logo" src="https://testthedocs.org/img/redactor-logo.png" height="140" />
  <h3 align="center">REDACTOR</h3>
</p>

---

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/testthedocs/Lobby)

A work in progress editor-in-chief to highlight potential linguistic and structural issues with your text. You can watch progress in the [poc](https://github.com/testthedocs/redactor/tree/poc) branch.

## Features

User enabled and overridable documentation checks, planned for inclusion in beta release:

- Check Markdown best practices
- Check RST best practices
- Check generated HTML best practices
- Validate links
- Spelling, Grammar, style and readability

## Dependencies

- [Docker](https://docker.com/)

## Documentation

Full documentation for end users can be found in the "[docs](./docs)" folder.

## Installation

None right now.

## Usage

None right now.

## 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.

- [Issue Tracker](https://github.com/testthedocs/redactor/issues/)
- [Source Code](https://github.com/testthedocs/redactor/)

## License

[MIT](https://choosealicense.com/licenses/mit/)

<p align="center">
  <img alt="Redactor Logo" src="https://testthedocs.org/img/redactor-logo.png" height="140" />
  <h3 align="center">REDACTOR</h3>
</p>

---

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/testthedocs/Lobby)

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

## Features

User enabled and overridable documentation checks, planned for inclusion in beta release:

- Check Markdown best practices
- Check RST best practices
- Check generated HTML best practices
- Validate links
- Spelling, Grammar, style and readability

## Dependencies

- [Docker](https://docker.com/)

## Documentation

Full documentation for end users can be found in the "[docs](./docs)" folder.

## Installation

None right now.

## Usage

None right now.

## 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.

- [Issue Tracker](https://github.com/testthedocs/redactor/issues/)
- [Source Code](https://github.com/testthedocs/redactor/)

## License

[MIT](https://choosealicense.com/licenses/mit/)

Remove old link to poc branch
docs: Remove old link to poc branch
