markdownlint-cli/README.md
Robert Kaussow 57c718f6e1
Some checks failed
ci/woodpecker/push/build-package Pipeline was successful
ci/woodpecker/push/docs unknown status
ci/woodpecker/push/build-container Pipeline failed
ci/woodpecker/push/notify Pipeline was successful
refactor: migrate to woodpecker ci (#121)
Reviewed-on: #121
Co-authored-by: Robert Kaussow <mail@thegeeklab.de>
Co-committed-by: Robert Kaussow <mail@thegeeklab.de>
2023-11-08 09:03:03 +01:00

35 lines
1.3 KiB
Markdown

# 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)
[![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 -->
Custom container image for [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) optimized for CI.
## Usage
```Shell
docker run -v $(pwd):/src markdownlint-cli
# or pass arguments to markdownlint-cli
docker run -v $(pwd):/src markdownlint-cli -p .gitignore
```
## 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.