chore: add markdownlint config and declare code-fence languages#552
Merged
Conversation
Add a scoped .markdownlint-cli2.jsonc so the editor, CLI, and the pre-commit hook agree on rules. Enables MD024 (siblings_only, for repeated per-CVE headings) and MD040; leaves MD013 and MD060 off since the docs use aligned tables and MD060 has no auto-fixer in this version. Declare a language on previously-bare fenced code blocks (MD040): text for URLs, directory trees, key mappings, and sample output; bash for command blocks. No prose or table reflow.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Retro markdown linting, split out from the
#546CSP work as a standalone chore..markdownlint-cli2.jsoncso the VS Code extension, the CLI, and the global pre-commit hook agree on rules:MD024→siblings_only(allows repeated per-CVE headings under different parents)MD040→ on (fenced code blocks must declare a language)MD013(line length) andMD060(table column style) left off — the docs use aligned/padded tables andMD060has no auto-fixer in this version, so enforcing it would mean reformatting every table.MD040):textfor URLs, directory trees, key mappings, and sample output;bashfor command blocks.Why
VS Code was surfacing a large number of markdown lint warnings. This makes the repo
markdownlint-cli2clean (0 errors / 100 files) without any prose or table reflow.Notes
feat/546-csp-json-config.