Skip to content

Commit a4ae135

Browse files
chore: update markdownlint config and rename mise.toml to dotfile
Migrate markdownlint to cli2 format with schema validation. Disable MD024 for Keep a Changelog repeated headings and MD060 for mixed table styles. Expand allowed HTML elements and code fence languages. Add .markdownlintignore for generated/third-party directories. Rename mise.toml to .mise.toml per dotfile convention.
1 parent 7c545a8 commit a4ae135

File tree

5 files changed

+53
-17
lines changed

5 files changed

+53
-17
lines changed

.markdownlint-cli2.jsonc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json",
3+
// Common directories to ignore (generated/third-party content)
4+
"ignores": [".venv/**", "node_modules/**", "vendor/**", "target/**"]
5+
}

.markdownlint.jsonc

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,60 @@
11
{
2+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json",
23
"default": true,
34
"MD003": {
4-
"style": "atx"
5+
"style": "atx",
56
},
67
"MD004": {
7-
"style": "dash"
8+
"style": "dash",
89
},
910
"MD007": {
10-
"indent": 2
11+
"indent": 2,
1112
},
1213
"MD013": {
1314
"line_length": 100,
1415
"code_blocks": false,
1516
"tables": false,
1617
"headings": false,
17-
"strict": false
18-
},
19-
"MD024": {
20-
"siblings_only": true
18+
"strict": false,
2119
},
20+
// MD024: Disabled to allow Keep a Changelog format in CHANGELOG.md
21+
// which uses repeated section headings (Added, Changed, Fixed, Removed)
22+
"MD024": false,
2223
"MD029": {
23-
"style": "ordered"
24+
"style": "ordered",
2425
},
2526
"MD033": {
2627
"allowed_elements": [
28+
"a",
29+
"br",
30+
"details",
2731
"div",
32+
"figcaption",
33+
"figure",
34+
"hostname",
2835
"img",
29-
"br",
36+
"picture",
37+
"source",
38+
"strong",
39+
"sub",
40+
"summary",
3041
"sup",
31-
"sub"
32-
]
42+
],
3343
},
3444
"MD035": {
35-
"style": "---"
45+
"style": "---",
3646
},
3747
"MD040": {
3848
"allowed_languages": [
3949
"bash",
4050
"c",
51+
"cmake",
4152
"cpp",
4253
"csharp",
43-
"cmake",
4454
"diff",
4555
"dockerfile",
4656
"ebnf",
57+
"ini",
4758
"glsl",
4859
"hcl",
4960
"json",
@@ -62,11 +73,14 @@
6273
"typescript",
6374
"wgsl",
6475
"xml",
65-
"yaml"
76+
"yaml",
6677
],
67-
"language_only": false
78+
"language_only": false,
6879
},
6980
"MD046": {
70-
"style": "fenced"
71-
}
81+
"style": "fenced",
82+
},
83+
// MD060: Table column style - disabled because existing tables use mixed
84+
// styles (some compact, some expanded). Tables are readable as-is.
85+
"MD060": false,
7286
}

.markdownlintignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Third-party dependencies
2+
.venv
3+
node_modules
4+
vendor
5+
target
6+
7+
# Standard license text
8+
LICENSE.md
9+
10+
# YAML files (not Markdown)
11+
.github/workflows/*.yml
12+
.github/workflows/*.yaml
File renamed without changes.

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717

1818
### Changed
1919

20+
- Updated markdownlint configuration: added `$schema`, disabled MD024 for
21+
Keep a Changelog format, disabled MD060, expanded allowed HTML elements and
22+
code fence languages
23+
- Added `.markdownlint-cli2.jsonc` config and `.markdownlintignore`
24+
- Renamed `mise.toml` to `.mise.toml` (dotfile convention)
2025
- Upgraded `glam` from 0.29 to 0.31
2126
- Upgraded `bitflags` from 2.9 to 2.10
2227
- Upgraded `ordered-float` from 5.0 to 5.1

0 commit comments

Comments
 (0)