What problem does it solve?
Markdown linting errors often go unnoticed until CI/CD fails, causing delays. This Skill automates the installation of a pre-commit Git hook that automatically lints staged Markdown files, providing immediate feedback and preventing commits with formatting errors, saving you time and ensuring documentation quality.
Core Features & Use Cases
- Automated Hook Installation: Installs a pre-commit hook that runs
markdownlint-cli2 on staged .md files.
- Early Error Detection: Catches Markdown linting errors before they are committed, preventing CI failures.
- Verification & Testing: Guides through verifying the hook installation and testing its functionality.
- Bypass & Uninstall: Provides instructions for temporarily bypassing the hook or completely uninstalling it.
- Use Case: You're working on documentation and want to ensure it's always perfectly formatted. Use this Skill to install a Git hook that automatically checks your Markdown files before every commit, ensuring consistency and preventing linting issues from reaching your repository.
Quick Start
Install the pre-commit Git hooks in this project.