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
examples
.dockerignore
.gitignore
.remarkrc.yaml
CHANGELOG.rst
LICENSE
Makefile
README.rst
VERSION

README.rst

TTD Remark Lint

Docker image for remark-lint markdown code style linter.

This image uses the container zemanlx/remark-lint as base.

The only difference is that that ttd-remark-lint includes Tini and runs as ttd user.

Dependencies

Installation

Pull the image:

docker pull testthedocs/ttd-remark-lint

Usage

Run remark-lint from in your docs directory:

docker run --rm -i -v $PWD:/lint/input:ro testthedocs/ttd-remark .

Default configuration:

plugins:
  preset-lint-consistent:
  preset-lint-markdown-style-guide:
  preset-lint-recommended:
  validate-links:

Contribute

Support

If you are having issues, please let us know.

License

MIT