TTD Textlint¶

Abstract

A pluggable linting tool for text and markdown.

Based on: textlint.

Installation¶

Dependencies¶

Docker

Configuration¶

ttd-textlint expects a configuration file called .textlintrc

{
  "plugins": [
    "rst"
  ],
  "rules": {
    "write-good": {
      "so": true
    }
  }
}

For more info, please read the documentation about configuring textlint.

Usage¶

docker run -v `pwd`:/srv testthedocs/ttd-textlint *

If you have any validation ttd-textlint will report them.

_images/ttd-textlinter-example.gif

Source Code¶

The code of ttd-textlint is located on GitHub.