Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/avto-dev/markdown-lint

Linter for markdown (with presets)
https://github.com/avto-dev/markdown-lint

docker linter markdown

Last synced: 24 days ago
JSON representation

Linter for markdown (with presets)

Host: GitHub
URL: https://github.com/avto-dev/markdown-lint
Owner: avto-dev
License: mit
Created: 2020-01-17T16:34:36.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-10-03T07:22:09.000Z (8 months ago)
Last Synced: 2024-04-21T17:21:34.222Z (about 1 month ago)
Topics: docker, linter, markdown
Language: JavaScript
Homepage: https://hub.docker.com/repository/docker/avtodev/markdown-lint/tags
Size: 62.5 KB
Stars: 77
Watchers: 4
Forks: 12
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-workflows - Linter for markdown (with presets)
awesome-actions - Linter for markdown (with presets)
awesome-actions - Linter for markdown (with presets)
fucking-awesome-actions - Linter for markdown (with presets)
awesome-actions-fork - Linter for markdown (with presets)
awesome-actions - Linter for markdown (with presets)
awesome-actions - Linter for markdown (with presets)

README

        


 



# Linter for markdown _{^{| with presets}}

![Release][badge_release]

[![Build][badge_ci]][link_actions]

[![Build][badge_build]][link_hub]

[![Docker Pulls][badge_pulls]][link_hub]

[![Issues][badge_issues]][link_issues]

[![License][badge_license]][link_license]

This repository contains source files of docker image (and [github action][github_actions_doc]) for markdown files linting. Additionally we provides setting _(rules)_ for the most useful cases, like changelog file linting.

All docker images always can be found on **[this page][link_hub_tags]**.

## Usage

This image contains [markdownlint-cli][markdownlint-cli] (node-js) and:

- Additional rules for `changelog` file linting _(`/lint/rules/changelog.js`)_

- Configuration file for `changelog` file linting _(it uses additional linting rules, `/lint/config/changelog.yml`)_

> Major image tag can be updated in any time, but all changes will be backwards compatible.

`markdownlint-cli` supports next options (more details can be found [on project page][markdownlint-cli]):

```bash

Usage: markdownlint [options] 

Options:

  -h, --help                                  output usage information

  -V, --version                               output the version number

  -f, --fix                                   fix basic errors (does not work with STDIN)

  -s, --stdin                                 read from STDIN (does not work with files)

  -o, --output [outputFile]                   write issues to file (no console)

  -c, --config [configFile]                   configuration file (JSON, JSONC, or YAML)

  -i, --ignore [file|directory|glob]          files to ignore/exclude

  -r, --rules  [file|directory|glob|package]  custom rule files

```

### Environment variables

Some linter execution options can be passed through environment variables _(multiple variables usage are allowed)_:

Environment variable    | Interpretation

----------------------- | --------------

`INPUT_RULES=/foo.js`   | `markdownlint --rules /foo.js ...`

`INPUT_CONFIG=/bar.yml` | `markdownlint --config /bar.yml ...`

`INPUT_FIX=true`        | `markdownlint --fix ...`

`INPUT_OUTPUT=/foo`     | `markdownlint --output /foo ...`

`INPUT_IGNORE=/bar`     | `markdownlint --ignore /bar ...`

### Docker

For example, you can lint your `CHANGELOG.md` file using following command:

```bash

$ docker run --rm \

    -v "$(pwd)/CHANGELOG.md:/CHANGELOG.md:ro" \

    avtodev/markdown-lint:v1 \

    --rules /lint/rules/changelog.js \

    --config /lint/config/changelog.yml \

    /CHANGELOG.md

```

or

```bash

$ docker run --rm \

    -v "$(pwd)/CHANGELOG.md:/CHANGELOG.md:ro" \

    -e INPUT_RULES=/lint/rules/changelog.js \

    -e INPUT_CONFIG=/lint/config/changelog.yml \

    avtodev/markdown-lint:v1 \

    /CHANGELOG.md

```

### GitHub Actions

```yaml

jobs:

  lint-changelog:

    name: Lint changelog file

    runs-on: ubuntu-latest

    steps:

    - name: Check out code

      uses: actions/checkout@v2

    - name: Lint changelog file

      uses: docker://avtodev/markdown-lint:v1 # fastest way

      with:

        rules: '/lint/rules/changelog.js'

        config: '/lint/config/changelog.yml'

        args: './CHANGELOG.md'

        ignore: './one_file.md ./another_file.md' # multiple files must be separated with single space

    # Or using current repository as action:

    - name: Lint changelog file

      uses: avto-dev/markdown-lint@v1

      with:

        rules: '/lint/rules/changelog.js'

        config: '/lint/config/changelog.yml'

        args: './CHANGELOG.md'

```

### License

MIT. Use anywhere for your pleasure.

[badge_release]:https://img.shields.io/github/v/release/avto-dev/markdown-lint?include_prereleases&style=flat-square&maxAge=10

[badge_ci]:https://img.shields.io/github/actions/workflow/status/avto-dev/markdown-lint/ci.yml

[badge_pulls]:https://img.shields.io/docker/pulls/avtodev/markdown-lint.svg?style=flat-square&maxAge=30

[badge_issues]:https://img.shields.io/github/issues/avto-dev/markdown-lint.svg?style=flat-square&maxAge=30

[badge_build]:https://img.shields.io/docker/v/avtodev/markdown-lint

[badge_license]:https://img.shields.io/github/license/avto-dev/markdown-lint.svg?style=flat-square&maxAge=30

[link_hub]:https://hub.docker.com/r/avtodev/markdown-lint/

[link_hub_tags]:https://hub.docker.com/r/avtodev/markdown-lint/tags

[link_license]:https://github.com/avto-dev/markdown-lint/blob/master/LICENSE

[link_issues]:https://github.com/avto-dev/markdown-lint/issues

[link_actions]:https://github.com/avto-dev/markdown-lint/actions

[markdownlint-cli]:https://github.com/igorshubovych/markdownlint-cli

[github_actions_doc]:https://help.github.com/en/actions