Skip to content

Commit

Permalink
Use default names for the markdown linter
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed May 14, 2024
1 parent c28d001 commit 2082bca
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 3 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/check_markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,3 @@ jobs:
uses: actions/checkout@v2

- uses: articulate/actions-markdownlint@v1
with:
config: markdownlint.json
File renamed without changes.
1 change: 1 addition & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/index.md
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,8 @@ Filename |Descriptions
[mlc_config.json](mlc_config.json) |Configuration of the link checker, use `markdown-link-check --config mlc_config.json --quiet docs/**/*.md` to do link checking locally
[.spellcheck.yml](.spellcheck.yml) |Configuration of the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally
[.wordlist.txt](.wordlist.txt) |Whitelisted words for the spell checker, use `pyspelling -c .spellcheck.yml` to do spellcheck locally
[markdownlint.json](markdownlint.json)|Configuration of the markdown linter, use `markdownlint --config markdownlint.json **/*.md` to do markdown linting locally
[.markdownlint.jsonc](.markdownlint.jsonc)|Configuration of the markdown linter, use `markdownlint **/*.md` to do markdown linting locally. The name of this file is a default name.
[.markdownlintignore](.markdownlintignore)|Files ignored by the markdown linter, use `markdownlint **/*.md` to do markdown linting locally. The name of this file is a default name.

## Credits

Expand Down

0 comments on commit 2082bca

Please sign in to comment.