Sign inSign up

tmknom/textlint-for-tech

By tmknom

•Updated over 7 years ago

The pluggable natural language linter for technical writing.

Image
0

2.2K

tmknom/textlint-for-tech repository overview

⁠textlint-for-tech

CircleCI Docker Build Status Docker Automated build MicroBadger Size MicroBadger Layers License

The pluggable natural language linter for technical writing.

This is textlint⁠ wrapper.

⁠Requirements

⁠Usage

⁠Lint markdown
docker run --rm -v "$PWD:/work" tmknom/textlint-for-tech --config .textlintrc **/*.md
⁠Lint review
docker run --rm -v "$PWD:/work" tmknom/textlint-for-tech --config .textlintrc **/*.re
⁠Help
docker run --rm tmknom/textlint-for-tech --help

⁠Supported file formats

  • plain text
  • Markdown
  • Re:VIEW

⁠Supported plugins

⁠Makefile targets

build                          Build docker image
format                         Format code
help                           Show help
install                        Install requirements
lint                           Lint code

⁠Development

⁠Installation
git clone [email protected]:tmknom/textlint-for-tech.git
cd textlint-for-tech
make install
⁠Deployment

Automatically deployed by "DockerHub Automated Build⁠" after merge.

⁠Deployment Pipeline
  1. GitHub - Version Control System
  2. CircleCI - Continuous Integration
  3. Docker Hub - Docker Registry
  4. MicroBadger - Docker Inspection

⁠License

Apache 2 Licensed. See LICENSE for full details.

Tag summary

Content type

Image

Digest

Size

42.4 MB

Last updated

over 7 years ago

docker pull tmknom/textlint-for-tech