Project Guidelines

Markdown Style

All .md files in this project must pass markdownlint. Key rules to follow:

MD022: Always add a blank line above and below every heading
MD032: Always add a blank line above and below every list (including after bold labels like **Examples:**)
MD041: The first line of every file must be a top-level # heading
MD031: Fenced code blocks must be surrounded by blank lines
MD040: Fenced code blocks must have a language specifier — use bash for shell commands, java for Java code, text for ASCII diagrams and program output
MD060: Table separator rows must have spaces inside pipes — use | --- | not |---|
MD024: Headings within the same file must have unique text

Run markdownlint across all README files (MD013 line-length is disabled project-wide):

npx markdownlint-cli --disable MD013 -- $(find . -name "*.md" | grep -v node_modules)

Auto-fix all fixable issues:

npx markdownlint-cli --fix --disable MD013 -- $(find . -name "*.md" | grep -v node_modules)

Rules that require manual fixes (not auto-fixable): MD040, MD060, MD024.