Skip to content

Commit 73ce535

Browse files
fergusbissetclaude
andcommitted
Relax markdownlint rules for design system documentation
Disabled strict markdown formatting rules that conflict with compact technical documentation style: - MD022: blank lines around headings - MD026: trailing punctuation in headings - MD029: ordered list prefix style - MD031: blank lines around fenced code blocks - MD032: blank lines around lists - MD040: language specification for code blocks - MD060: table column style 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 37b0749 commit 73ce535

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

scripts/config/markdownlint.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,37 @@ MD010: # no-hard-tabs
99
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
1010
MD013: false
1111

12+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md
13+
# Headings should be surrounded by blank lines - disabled for compact docs
14+
MD022: false
15+
1216
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
1317
MD024:
1418
siblings_only: true
1519

20+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md026.md
21+
# Allow trailing punctuation in headings (common in step-by-step docs)
22+
MD026: false
23+
24+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md
25+
# Allow any ordered list prefix style
26+
MD029: false
27+
28+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md
29+
# Fenced code blocks blank lines - disabled for compact docs
30+
MD031: false
31+
32+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md032.md
33+
# Lists should be surrounded by blank lines - disabled for compact docs
34+
MD032: false
35+
1636
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
1737
MD033: false
38+
39+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md
40+
# Allow fenced code blocks without language specification
41+
MD040: false
42+
43+
# https://github.com/DavidAnson/markdownlint/blob/main/doc/md060.md
44+
# Table column style - disabled for flexibility
45+
MD060: false

0 commit comments

Comments
 (0)