tmknom/markdownlint repository overview

⁠markdownlint

A style checker and lint tool for Markdown files.

⁠Description

This image is markdownlint⁠ and markdownlint-cli⁠ wrapper. It is a static analysis tool for Node.js with a library of rules to enforce standards and consistency for Markdown files.

It is a useful tool, but there is no official image. Therefore, this repository distributes a lightweight image based on alpine.

⁠Docker registries

You can pull from Docker Hub or GitHub Packages, whichever you prefer.

⁠Docker Hub

docker pull tmknom/markdownlint

For more information, see Docker Hub⁠.

⁠GitHub Packages

docker pull ghcr.io/tmknom/dockerfiles/markdownlint

For more information, see GitHub Packages⁠.

⁠Usage

⁠Lint a Markdown file

docker run --rm -v $(pwd):/work tmknom/markdownlint README.md

⁠Lint all Markdown files in a directory

docker run --rm -v $(pwd):/work tmknom/markdownlint -- .

⁠Help

docker run --rm tmknom/markdownlint --help

⁠Supported platforms

• linux/amd64
• linux/arm64

⁠Source repository

• tmknom/dockerfiles⁠

⁠License

Apache 2 Licensed. See LICENSE⁠ for full details.