mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
feat(quality): add markdownlint-cli2 to quality checks (#1039)
- Add markdownlint-cli2 as dev dependency - Add lint:md script to package.json - Add markdownlint job to CI workflow - Configure 5 rules: heading-increment, no-duplicate-heading, no-trailing-punctuation, no-bare-urls, no-space-in-emphasis - Fix existing violations across 19 markdown files - No auto-fix to prevent destructive changes Closes #1034 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Brian <bmadcode@gmail.com>
This commit is contained in:
42
.markdownlint-cli2.yaml
Normal file
42
.markdownlint-cli2.yaml
Normal file
@@ -0,0 +1,42 @@
|
||||
# markdownlint-cli2 configuration
|
||||
# https://github.com/DavidAnson/markdownlint-cli2
|
||||
|
||||
ignores:
|
||||
- node_modules/**
|
||||
- test/fixtures/**
|
||||
- CODE_OF_CONDUCT.md
|
||||
- .bmad/**
|
||||
- .bmad*/**
|
||||
- .agent/**
|
||||
- .claude/**
|
||||
- .roo/**
|
||||
- .codex/**
|
||||
- .agentvibes/**
|
||||
- .kiro/**
|
||||
- sample-project/**
|
||||
- test-project-install/**
|
||||
- z*/**
|
||||
|
||||
# Rule configuration
|
||||
config:
|
||||
# Disable all rules by default
|
||||
default: false
|
||||
|
||||
# Heading levels should increment by one (h1 -> h2 -> h3, not h1 -> h3)
|
||||
MD001: true
|
||||
|
||||
# Duplicate sibling headings (same heading text at same level under same parent)
|
||||
MD024:
|
||||
siblings_only: true
|
||||
|
||||
# Trailing commas in headings (likely typos)
|
||||
MD026:
|
||||
punctuation: ","
|
||||
|
||||
# Bare URLs - may not render as links in all parsers
|
||||
# Should use <url> or [text](url) format
|
||||
MD034: true
|
||||
|
||||
# Spaces inside emphasis markers - breaks rendering
|
||||
# e.g., "* text *" won't render as emphasis
|
||||
MD037: true
|
||||
Reference in New Issue
Block a user