Skip to content

Auto-format Markdown files via pre-commit hook#196

Open
falkoschindler wants to merge 1 commit intomainfrom
mdformat
Open

Auto-format Markdown files via pre-commit hook#196
falkoschindler wants to merge 1 commit intomainfrom
mdformat

Conversation

@falkoschindler
Copy link
Collaborator

Motivation

Enforce consistent Markdown formatting across the project automatically via pre-commit, so documentation style stays uniform without manual effort.

Implementation

Add an mdformat hook to .pre-commit-config.yaml with:

  • --wrap keep to preserve existing line wrapping
  • --number to avoid enumerating all ordered list items with 1.
  • mdformat-gfm plugin for GitHub-flavored Markdown support
  • mdformat-simple-breaks plugin to keep --- for horizontal rules (instead of 70 underscores)
  • .cursor/ directory excluded

Existing Markdown files have been auto-formatted by the hook.

Progress

  • The implementation is complete.
  • Test is not necessary.
  • Documentation is not necessary.

@falkoschindler falkoschindler added this to the 0.11.0 milestone Mar 13, 2026
@falkoschindler falkoschindler added the documentation Improvements or additions to documentation label Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant