Skip to content

Commit a99a88f

Browse files
DaveSkenderclaude
andcommitted
ci: add markdown lint job and gate it in lint-and-test
Add a dedicated markdown job (markdownlint, org-standard config) and include it in the lint-and-test aggregator's needs so markdown is covered by the required check; existing violations fixed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 14e8e4b commit a99a88f

2 files changed

Lines changed: 31 additions & 1 deletion

File tree

.github/workflows/ci.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,17 @@ jobs:
3030
run: |
3131
pylint $(git ls-files '*.py')
3232
33+
markdown:
34+
runs-on: ubuntu-slim
35+
steps:
36+
- name: Checkout source code
37+
uses: actions/checkout@v6
38+
- name: Lint markdown
39+
uses: DavidAnson/markdownlint-cli2-action@v23
40+
3341
lint-and-test:
3442
runs-on: ubuntu-slim
35-
needs: [build]
43+
needs: [build, markdown]
3644
if: always()
3745
steps:
3846
- name: Verify required jobs succeeded

.markdownlint-cli2.jsonc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"globs": ["**/*.md"],
3+
"gitignore": true,
4+
"ignores": ["node_modules/**"],
5+
"config": {
6+
"default": true,
7+
"MD003": { "style": "atx" },
8+
"MD004": { "style": "dash" },
9+
"MD007": { "indent": 2 },
10+
"MD013": false, // allow long lines
11+
"MD024": { "siblings_only": true },
12+
"MD028": false, // allow separation between quote blocks
13+
"MD033": {
14+
"allowed_elements": ["details", "summary", "br", "sub", "sup", "kbd", "abbr", "a", "img"]
15+
},
16+
"MD041": false,
17+
"MD046": { "style": "fenced" },
18+
"MD048": { "style": "backtick" },
19+
"MD055": { "style": "leading_and_trailing" },
20+
"MD060": { "style": "compact", "aligned_delimiter": false }
21+
}
22+
}

0 commit comments

Comments
 (0)