Skip to content

Commit 15c7468

Browse files
committed
Add markdownlint configuration and CI workflow for documentation linting
Signed-off-by: sumitgiri87 <[email protected]>
1 parent b5d3dac commit 15c7468

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.github/workflows/markdownlint.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Markdown Lint
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '**/*.md'
7+
8+
jobs:
9+
markdownlint:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout repo
14+
uses: actions/checkout@v3
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '18'
20+
21+
- name: Install markdownlint-cli
22+
run: npm install -g markdownlint-cli
23+
24+
- name: Run markdownlint
25+
run: markdownlint '**/*.md' --ignore node_modules

.markdownlint.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"default": true,
3+
"MD013": false,
4+
"MD033": false
5+
}

0 commit comments

Comments
 (0)