Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DavidAnson/markdownlint-cli2-action
A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with the markdownlint library
https://github.com/DavidAnson/markdownlint-cli2-action
Last synced: 17 days ago
JSON representation
A GitHub Action to run the markdownlint-cli2 tool for linting Markdown/CommonMark files with the markdownlint library
- Host: GitHub
- URL: https://github.com/DavidAnson/markdownlint-cli2-action
- Owner: DavidAnson
- License: mit
- Created: 2021-01-13T05:28:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T15:41:35.000Z (21 days ago)
- Last Synced: 2024-10-22T02:53:33.139Z (21 days ago)
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/markdownlint-cli2-action
- Size: 2.72 MB
- Stars: 92
- Watchers: 5
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# markdownlint-cli2-action
> A GitHub Action to run the [`markdownlint-cli2`][markdownlint-cli2] tool for
linting [Markdown][markdown]/[CommonMark][commonmark] files with
[`markdownlint`][markdownlint]
`markdownlint-cli2` has extensive support for configuring options and disabling
or customizing `markdownlint` rules. See the
[`markdownlint-cli2` README][markdownlint-cli2] for more information.
`markdownlint` includes a wide variety of rules for analyzing and improving
Markdown content. See the [`markdownlint` README][markdownlint] for more
information.
## Inputs
### config (optional)
Path of a file to use for the base configuration object (defaults to none)
Equivalent to using the `--config` [command-line option][command-line] and
passing the specified configuration file.
### fix (optional)
Whether to fix supported issues automatically (any truthy value enables)
Equivalent to specifying the `--fix` [command-line option][command-line].
### globs (optional)
Glob expression(s) of files to lint (newline-delimited by default)
The default `*.{md,markdown}` lints all Markdown files in the base directory of
a project.
For more detail: [glob syntax in `markdownlint-cli2`][glob-syntax].
### separator (optional)
String to use as a separator for the `globs` input (defaults to newline)
Allows the `globs` input to use something other than `\n` to separate glob
expressions.
## Outputs
[None]
## Examples
To lint Markdown files in the base directory of a project:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
```
To lint all Markdown files in a project:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
globs: '**/*.md'
```
To lint specific Markdown files in a project:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
globs: |
README.md
CHANGELOG.md
docs/*.md
```
To use a custom separator:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
globs: 'README.md,CHANGELOG.md,docs/*.md'
separator: ','
```
To fix supported issues when linting:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
fix: true
globs: '**/*.md'
```
To specify a custom configuration file:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
with:
config: 'config/custom.markdownlint.jsonc'
globs: '**/*.md'
```
To prevent linting issues from failing the workflow run:
```yaml
- uses: DavidAnson/markdownlint-cli2-action@v17
continue-on-error: true
```
See [`example.yml`][example-yml] for a simple GitHub workflow that uses
`markdownlint-cli2-action`.
See [`changed.yml`][changed-yml] for a GitHub workflow that lints only the
Markdown files that changed in the most recent commit (useful for Pull Requests
and/or gradually introducing linting rules to a new repository).
[changed-yml]: .github/workflows/changed.yml
[command-line]: https://github.com/DavidAnson/markdownlint-cli2#command-line
[commonmark]: https://commonmark.org/
[example-yml]: .github/workflows/example.yml
[glob-syntax]: https://github.com/DavidAnson/markdownlint-cli2#use
[markdown]: https://wikipedia.org/wiki/Markdown
[markdownlint]: https://github.com/DavidAnson/markdownlint
[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2