Skip to content

Commit 327bbde

Browse files
committed
Fix markdownlint configuration to exclude external directories
- Add ignores to .markdownlint-cli2.yaml for devito_repo/, venv/, etc. - Disable MD018 (shebang false positives) and MD036 (exercise labels)
1 parent b8c83de commit 327bbde

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

.markdownlint-cli2.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,13 @@
33
globs:
44
- "**/*.md"
55
- "**/*.qmd"
6+
7+
# Exclude external and generated directories
8+
ignores:
9+
- "devito_repo/**"
10+
- "venv/**"
11+
- ".venv/**"
12+
- "node_modules/**"
13+
- "_book/**"
14+
- "doc/pub/**"
15+
- "devito-plan.md"

.markdownlint.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ MD022: false
5353
# MD012 - Multiple consecutive blank lines (false positives in Python code blocks with PEP8 style)
5454
MD012: false
5555

56+
# MD018 - No space after hash (false positive from #!/bin/bash shebangs in code blocks)
57+
MD018: false
58+
59+
# MD036 - Emphasis as heading (false positive from a) b) c) exercise labels)
60+
MD036: false
61+
5662
# MD004 - Unordered list style (allow both dash and plus - converted from DocOnce)
5763
MD004: false
5864

0 commit comments

Comments
 (0)