markdownlint-cli/README.md

35 lines
1.3 KiB
Markdown
Raw Normal View History

2020-10-27 20:54:28 +00:00
# markdownlint-cli
Custom image for markdownlint-cli
<!-- spellchecker-disable -->
[![Build Status](https://ci.rknet.org/api/badges/container/markdownlint-cli/status.svg)](https://ci.rknet.org/repos/container/markdownlint-cli)
2020-10-27 20:54:28 +00:00
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/markdownlint-cli)
[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/markdownlint-cli)
[![Source: Gitea](https://img.shields.io/badge/source-gitea-blue.svg?logo=gitea&logoColor=white)](https://gitea.rknet.org/container/markdownlint-cli)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitea.rknet.org/container/markdownlint-cli/src/branch/main/LICENSE)
<!-- spellchecker-enable -->
2020-10-27 20:54:28 +00:00
Custom container image for [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) optimized for CI.
2020-10-27 20:54:28 +00:00
## Usage
```Shell
docker run -v $(pwd):/src markdownlint-cli
2020-10-27 20:54:28 +00:00
# or pass arguments to markdownlint-cli
docker run -v $(pwd):/src markdownlint-cli -p .gitignore
2020-10-27 20:54:28 +00:00
```
## Build
```Shell
docker build -t markdownlint-cli:latest .
```
## License
This project is licensed under the MIT License - see the [LICENSE](https://gitea.rknet.org/container/markdownlint-cli/src/branch/main/LICENSE) file for details.