Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruzickap/action-my-markdown-linter
Style checking and linting for Markdown files
https://github.com/ruzickap/action-my-markdown-linter
actions github-action github-actions lint linter linters linting markdown
Last synced: 2 months ago
JSON representation
Style checking and linting for Markdown files
- Host: GitHub
- URL: https://github.com/ruzickap/action-my-markdown-linter
- Owner: ruzickap
- License: apache-2.0
- Created: 2020-07-13T13:42:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T03:20:03.000Z (2 months ago)
- Last Synced: 2024-10-27T03:24:31.219Z (2 months ago)
- Topics: actions, github-action, github-actions, lint, linter, linters, linting, markdown
- Language: Shell
- Homepage:
- Size: 181 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GitHub Actions: My Markdown Linter ✔
[](https://github.com/marketplace/actions/my-markdown-linter)
[](https://github.com/ruzickap/action-my-markdown-linter/blob/main/LICENSE)
[](https://github.com/ruzickap/action-my-markdown-linter/releases/latest)
[](https://github.com/ruzickap/action-my-markdown-linter/releases)
[](https://hub.docker.com/r/peru/my-markdown-linter)
This is a GitHub Action to lint Markdown files.
It's using the [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli)
and [fd](https://github.com/sharkdp/fd).
See the basic GitHub Action example:
```yaml
name: markdown_lint
on:
push:
jobs:
markdown_lint:
name: Check Markdown files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Markdown Lint
uses: ruzickap/action-my-markdown-linter@v1
```
## Parameters
Variables used by `action-my-markdown-linter` GitHub Action:
| Variable | Default | Description |
|-----------------|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `config_file` | `.markdownlint.yaml` / `.markdownlint.yml` (if exists) | [Config file](https://github.com/igorshubovych/markdownlint-cli#configuration) used by [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) |
| `debug` | (not defined) | Enable debug mode for the [entrypoint.sh](entrypoint.sh) script (`set -x`) |
| `exclude` | (not defined) | Exclude files or directories - see the [--exclude parameter](https://github.com/sharkdp/fd#excluding-specific-files-or-directories) of [fd](https://github.com/sharkdp/fd) command |
| `fd_cmd_params` | `. -0 --extension md --type f --hidden --no-ignore` | Set your own parameters for [fd](https://github.com/sharkdp/fd) command. `exclude` and `search_paths` parameters are ignored if this is set. |
| `search_paths` | (not defined) | By default all `*.md` are checked in whole repository, but you can specify directories |
Non of the parameters above are "mandatory".
## Full example
GitHub Action example:
```yaml
name: markdown_lint
on:
push:
branches:
- main
jobs:
markdown_lint:
name: Check Markdown files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Markdown Lint
uses: ruzickap/action-my-markdown-linter@v1
with:
config_file: my_markdownlint.yml
debug: true
exclude: |
my_exclude_dir/md_files/
my_exclude_dir_2/markdown_files/
CHANGELOG.md
search_paths: |
check_dir_1/md_files/
check_dir_2/markdown_files/
- name: Markdown Lint - check only 'docs' directory and exclude CHANGELOG.md
uses: ruzickap/action-my-markdown-linter@v1
with:
search_paths: |
docs/
exclude: |
CHANGELOG.md
- name: Markdown Lint - simple example
uses: ruzickap/action-my-markdown-linter@v1
- name: Markdown Lint using pre-built container
uses: docker://peru/my-markdown-linter@v1
```
## Running locally
It's possible to use the Markdown linter task locally using docker:
```bash
docker run --rm -t -v "${PWD}/tests/test2:/mnt" peru/my-markdown-linter
```
Output:
```text
*** Start checking...
*** Running: fd . -0 --extension md --type f --hidden --no-ignore
*** Running: markdownlint normal.md
*** Checks completed...
```
Or you can also use parameters:
```bash
export INPUT_EXCLUDE="CHANGELOG.md test1/excluded_file.md bad.md excluded_dir/"
export INPUT_SEARCH_PATHS="tests/"
docker run --rm -t -e INPUT_EXCLUDE -e INPUT_SEARCH_PATHS -v "${PWD}:/mnt" peru/my-markdown-linter
```
Output:
```text
*** Start checking...
*** Running: fd . -0 --extension md --type f --hidden --no-ignore --exclude CHANGELOG.md --exclude test1/excluded_file.md --exclude bad.md --exclude excluded_dir/ tests/
*** Running: markdownlint tests/test2/normal.md
*** Checks completed...
```
Demo:
[](https://asciinema.org/a/348715)
## Examples
Real examples of My Markdown Linter usage:
* [markdownlint-check](https://github.com/ruzickap/k8s-harbor/actions)
started by GH Action defined in [vuepress-build-check-deploy.yml](https://github.com/ruzickap/k8s-harbor/blob/f46d563919bc1494faae8b54ed9c9a6523ea7a87/.github/workflows/vuepress-build-check-deploy.yml#L25-L34)
* [markdownlint-check](https://github.com/ruzickap/action-my-markdown-linter/actions)
started by GH Action defined in [markdown.yml](https://github.com/ruzickap/action-my-markdown-linter/blob/ff96b5751a18c9a094840e8f5c41fd96e8195c06/.github/workflows/markdown.yml#L24-L29)