Skip to content

Commit e9026e4

Browse files
committed
feat: Add markdownlint workflow and configuration for improved documentation formatting
1 parent 3a89b6b commit e9026e4

File tree

3 files changed

+771
-0
lines changed

3 files changed

+771
-0
lines changed

.github/workflows/markdownlint.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Markdownlint Fixup
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
markdownlint:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout repository
11+
uses: actions/checkout@v4
12+
13+
- name: Use Node.js 20
14+
uses: actions/setup-node@v4
15+
with:
16+
node-version: 20
17+
cache: 'npm'
18+
19+
- name: Install markdownlint-cli2
20+
run: npm install --no-save markdownlint-cli2
21+
22+
- name: Run markdownlint fix
23+
run: npx markdownlint-cli2-fix "**/*.md" "#node_modules" "#dist"
24+
25+
- name: Show git diff
26+
run: git status --short && git diff
27+
*** End Patch

.markdownlint.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"default": true,
3+
"MD003": {
4+
"style": "atx"
5+
},
6+
"MD007": {
7+
"indent": 2
8+
},
9+
"MD009": {
10+
"br_spaces": 2,
11+
"ignore_code_blocks": true
12+
},
13+
"MD012": {
14+
"maximum": 1
15+
},
16+
"MD013": {
17+
"line_length": 120,
18+
"code_blocks": false,
19+
"tables": false,
20+
"headings": false
21+
},
22+
"MD022": {
23+
"lines_above": 1,
24+
"lines_below": 1
25+
},
26+
"MD023": true,
27+
"MD025": {
28+
"front_matter_title": "^#"
29+
},
30+
"MD026": {
31+
"punctuation": ".,;:!"
32+
},
33+
"MD029": {
34+
"style": "ordered"
35+
},
36+
"MD032": true,
37+
"MD033": false,
38+
"MD035": {
39+
"style": "---"
40+
},
41+
"MD041": true,
42+
"MD046": {
43+
"style": "fenced"
44+
}
45+
}

0 commit comments

Comments
 (0)