0d0297423e
Some checks failed
CI/CD Pipeline / Test Suite (push) Has been cancelled
CI/CD Pipeline / Security Audit (push) Has been cancelled
CI/CD Pipeline / Performance Benchmarks (push) Has been cancelled
Rust CI / Security Audit (push) Has been cancelled
Rust CI / Check + Test + Lint (nightly) (push) Has been cancelled
Rust CI / Check + Test + Lint (stable) (push) Has been cancelled
CI/CD Pipeline / Build Docker Image (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / Cleanup (push) Has been cancelled
106 lines
3.8 KiB
JSON
106 lines
3.8 KiB
JSON
// Markdownlint-cli2 Configuration
|
|
// Documentation quality enforcement for technical projects
|
|
// See: https://github.com/DavidAnson/markdownlint-cli2
|
|
// Generated by dev-system/ci
|
|
|
|
{
|
|
"config": {
|
|
"default": true,
|
|
|
|
// Headings - enforce proper hierarchy
|
|
"MD001": false, // heading-increment (relaxed - allow flexibility)
|
|
"MD026": false, // heading-punctuation (relaxed - allow ? and other punctuation)
|
|
|
|
// Lists - enforce consistency
|
|
"MD004": false, // ul-style (relaxed - allow mixed markers)
|
|
"MD005": false, // inconsistent-indentation (relaxed)
|
|
"MD007": false, // ul-indent (relaxed - flexible indentation)
|
|
"MD029": false, // ol-prefix (allow flexible list numbering)
|
|
"MD030": false, // list-marker-space (relaxed)
|
|
|
|
// Code blocks - fenced only
|
|
"MD046": { "style": "fenced" }, // code-block-style
|
|
"MD031": false, // blanks-around-fences (relaxed - allow tight spacing)
|
|
|
|
// CRITICAL: MD040 only checks opening fences, NOT closing fences
|
|
// It does NOT catch malformed closing fences with language specifiers (e.g., ```plaintext)
|
|
// CommonMark spec requires closing fences to be ``` only (no language)
|
|
// Use separate validation script to check closing fences
|
|
"MD040": false, // fenced-code-language (relaxed - code blocks without language OK)
|
|
|
|
// Formatting - relaxed whitespace
|
|
"MD009": false, // no-hard-tabs (relaxed)
|
|
"MD010": false, // hard-tabs (relaxed)
|
|
"MD011": true, // reversed-link-syntax
|
|
"MD018": true, // no-missing-space-atx
|
|
"MD019": true, // no-multiple-space-atx
|
|
"MD020": true, // no-missing-space-closed-atx
|
|
"MD021": true, // no-multiple-space-closed-atx
|
|
"MD023": false, // heading-starts-line (relaxed - allow indented headings)
|
|
"MD027": true, // no-multiple-spaces-blockquote
|
|
"MD037": true, // no-space-in-emphasis
|
|
"MD039": true, // no-space-in-links
|
|
|
|
// Trailing content
|
|
"MD012": false, // no-multiple-blanks (relaxed - allow formatting space)
|
|
"MD024": false, // no-duplicate-heading (too strict for docs)
|
|
"MD028": false, // no-blanks-blockquote (relaxed)
|
|
"MD047": false, // single-trailing-newline (relaxed)
|
|
|
|
// Links and references
|
|
"MD034": false, // no-bare-urls (relaxed - allow bare URLs)
|
|
"MD038": false, // no-space-in-code (relaxed - allow spaces in code spans)
|
|
"MD042": true, // no-empty-links
|
|
"MD051": false, // link-fragments (relaxed - allow emoji in anchors)
|
|
|
|
// HTML - allow for documentation formatting and images
|
|
"MD033": false, // no-inline-html (disabled - allow any HTML)
|
|
|
|
// Line length - disabled for technical documentation
|
|
"MD013": false, // line-length (disabled - technical docs often need long lines)
|
|
|
|
// Images
|
|
"MD045": true, // image-alt-text
|
|
|
|
// Tables - enforce proper formatting
|
|
"MD060": false, // table-column-style (relaxed - flexible table spacing)
|
|
|
|
// Disable rules that conflict with relaxed style
|
|
"MD003": false, // consistent-indentation
|
|
"MD041": false, // first-line-heading
|
|
"MD025": false, // single-h1 / multiple-top-level-headings
|
|
"MD022": false, // blanks-around-headings (flexible spacing)
|
|
"MD032": false, // blanks-around-lists (flexible spacing)
|
|
"MD035": false, // hr-style (consistent)
|
|
"MD036": false, // no-emphasis-as-heading
|
|
"MD044": false // proper-names
|
|
},
|
|
|
|
// Documentation patterns
|
|
"globs": [
|
|
"**/*.md",
|
|
"!node_modules/**",
|
|
"!target/**",
|
|
"!.git/**",
|
|
"!build/**",
|
|
"!dist/**"
|
|
],
|
|
|
|
// Ignore build artifacts, external content, and operational directories
|
|
"ignores": [
|
|
"node_modules/**",
|
|
"target/**",
|
|
".git/**",
|
|
"build/**",
|
|
"dist/**",
|
|
".coder/**",
|
|
".claude/**",
|
|
".wrks/**",
|
|
".vale/**",
|
|
".typedialog/**",
|
|
".woodpecker/**",
|
|
"templates/**",
|
|
"vendor/**"
|
|
]
|
|
}
|