Skip to content

Add markdown linting with prek and fix formatting#4

Merged
kraker merged 3 commits into
mainfrom
md-lint
Mar 24, 2026
Merged

Add markdown linting with prek and fix formatting#4
kraker merged 3 commits into
mainfrom
md-lint

Conversation

@kraker
Copy link
Copy Markdown
Owner

@kraker kraker commented Mar 24, 2026

Summary

  • Add prek pre-commit hooks with markdownlint for consistent markdown formatting
  • Switch MkDocs from legacy codehilite to pymdownx.highlight + pymdownx.superfences to fix code blocks rendering incorrectly inside ordered lists
  • Fix 2,764 lint violations across all 22+ markdown files (blank lines around headings/fences/lists, trailing whitespace, missing code fence languages, broken heredoc nesting, table pipe escaping)
  • Fix ordered list indentation from 3-space to 4-space for Python-Markdown compatibility
  • Update CLAUDE.md with markdown style guide and linting documentation
  • Update README.md with linting & pre-commit hooks section

Test plan

  • markdownlint '**/*.md' reports 0 violations
  • prek run --all-files passes
  • mkdocs build succeeds
  • Verified rendered HTML: code blocks now properly nested inside <li> elements
  • Spot-check pages on deployed site (e.g., File Permissions)

🤖 Generated with Claude Code

kraker and others added 3 commits March 24, 2026 11:31
- Add prek pre-commit hook with markdownlint --fix
- Add .markdownlint.yaml config (disable MD013, MD024, MD033, MD036)
- Add .markdownlintignore for sources/, site/, etc.
- Switch mkdocs.yml from codehilite to pymdownx.highlight + superfences
- Fix 2,764 lint violations: blank lines around headings/fences/lists/tables,
  trailing whitespace, missing code fence languages, broken heredoc nesting
- Fix ordered list indentation (3-space to 4-space) for Python-Markdown
  compatibility — code blocks now render correctly inside list items
- Update CLAUDE.md with markdown style guide and linting docs
- Update README.md with linting section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
CI installed a newer markdownlint-cli with MD060 (table-column-style)
rule not present in local v0.45.0. Pin CI version to 0.45.0 and disable
MD060 in config for consistency.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kraker kraker merged commit 92c8768 into main Mar 24, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant