aboutsummaryrefslogtreecommitdiff
path: root/.markdownlint-cli2.jsonc
diff options
context:
space:
mode:
Diffstat (limited to '.markdownlint-cli2.jsonc')
-rw-r--r--.markdownlint-cli2.jsonc16
1 files changed, 16 insertions, 0 deletions
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
new file mode 100644
index 0000000..bd36a04
--- /dev/null
+++ b/.markdownlint-cli2.jsonc
@@ -0,0 +1,16 @@
+// Markdown lint settings for `make docs` (markdownlint-cli2 in the docs image).
+// Default rules, with these deliberate exceptions:
+{
+ "config": {
+ "default": true,
+ // Prose lines are not hard-wrapped and tables can't wrap.
+ "MD013": false,
+ // The same subheading (e.g. "Tests") may repeat under different parents.
+ "MD024": { "siblings_only": true },
+ // Local URLs such as http://127.0.0.1:6080/vnc.html appear as plain text.
+ "MD034": false
+ },
+ "globs": ["**/*.md"],
+ // Generated or third-party files, and your original prompt (kept verbatim).
+ "ignores": ["node_modules/**", ".cache/**", "build/**", "Garmin OTP Prompt.md"]
+}