Skip to content

Commit 521553e

Browse files
committed
ci(markdownlint): add Markdown linting (reanahub#838)
1 parent aee31ce commit 521553e

File tree

6 files changed

+536
-505
lines changed

6 files changed

+536
-505
lines changed

.github/workflows/ci.yml

+14
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,17 @@ jobs:
193193
run: |
194194
pip install yamllint
195195
./run-tests.sh --check-yamllint
196+
197+
lint-markdownlint:
198+
runs-on: ubuntu-24.04
199+
steps:
200+
- name: Checkout
201+
uses: actions/checkout@v4
202+
203+
- name: Setup Node
204+
uses: actions/setup-node@v4
205+
206+
- name: Lint Markdown files
207+
run: |
208+
npm install markdownlint-cli2
209+
./run-tests.sh --check-markdownlint

.markdownlint.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
2+
MD013: false
3+
4+
# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md037.md
5+
MD037: false
6+
7+
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md041.md
8+
MD041: false
9+
10+
# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md043.md
11+
MD043: false

0 commit comments

Comments
 (0)