docker-textlint

Docker container with textlint.
textlint is Node.js based text linting utility for markdown and plaintext.

Rules

This image contains textlint rules as follows:

• textlint-rule-preset-ja-technical-writing
• textlint-filter-rule-comments
• textlint-filter-rule-allowlist

Installation

Pull from the GitHub Packages:

$ docker pull ghcr.io/miy4/textlint

Build from source:

$ git clone https://github.com/miy4/docker-textlint.git
$ cd docker-textlint
$ docker build -t miy4/textlint .

Usage

$ vi .textlintrc
# Edit textlint configurations

See textlint/docs/configuring.md and textlint/examples/config-file/ for more details.

$ docker run -v ${PWD}:/data -w /data miy4/textlint <TEXTLINT_ARGS>
# or
$ /path/to/run-textlint <TEXTLINT_ARGS>

docker run and run-textlint accept and pass a set of parameters to textlint CLI.

License

MIT