Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
dockerfiles
example
.gitignore
.textlintrc
CHANGELOG.rst
LICENSE
Makefile
README.rst
VERSION

README.rst

TTD Textlint

Custom setup of textlint in a Alpine container.

https://rakpart.testthedocs.org/_images/ttd-textlinter-example.gif

Features

  • textlint-rule-alex
  • textlint-rule-no-dead-link
  • textlint-rule-unexpanded-acronym
  • textlint-rule-write-good
  • textlint-rule-rousseau
  • textlint-plugin-rst
  • textlint-plugin-html
  • textlint-rule-max-number-of-lines
  • textlint-rule-terminology
  • Uses Tini as init.
  • Uses su-exec for setting user permissions.

Dependencies

Installation

Pull the container from Docker Hub

docker pull testthedocs/ttd-textlint

Usage

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

ttd-textlint expects a configuration file called .textlintrc

Example:

See the /docs directory for examples.

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

Contribute

Support

If you are having issues, please let us know.

License

MIT