Skip to content

Commit

Permalink
Add markdownlint
Browse files Browse the repository at this point in the history
Add a Markdown linter.
  • Loading branch information
martincostello committed Sep 28, 2024
1 parent 0c56362 commit 6cd3bce
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD041 -->
### Expected behaviour

<!-- Explain what you expected to happen. -->
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
name: Bug report
about: Create a bug report to help us improve the library
labels: bug
title: ''
---

### Describe the bug
Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
name: Feature request
about: Suggest an idea for a feature of this library
labels: feature-request
title: ''
---

### Is your feature request related to a problem? Please describe.
### Is your feature request related to a problem?

<!--
A clear and concise description of what the problem is. For example: _It would be useful if [...]_
Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,10 @@ jobs:
uses: docker://rhysd/actionlint@sha256:89d3f90f82781dee3c8724651129634b08cf2241bbd67fcd02a1c5198119fc5e # v1.7.2
with:
args: -color

- name: Lint markdown
uses: DavidAnson/markdownlint-cli2-action@db43aef879112c3119a410d69f66701e0d530809 # v17.0.0
with:
config: '.markdownlint.json'
globs: |
**/*.md
4 changes: 4 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"MD013": false,
"MD040": false
}

0 comments on commit 6cd3bce

Please sign in to comment.