markdownlint

The markdownlint skill provides automated expertise for maintaining the integrity, style, and syntax of Markdown documentation. It is designed for developers, technical writers, and researchers who need to ensure project-wide consistency in repositories by leveraging the markdownlint-cli2 tool. This skill automates the detection of common syntax errors, enforces specific style guidelines, and provides instant feedback or auto-fixing capabilities to streamline the documentation workflow.

• Linting Markdown files against configurable rules to identify structural issues, broken syntax, and inconsistent formatting.

• Automatic fixing of common issues to minimize manual editing overhead during code maintenance.

• Strict enforcement of project-specific rules, such as mandatory language identifiers for code fences (MD040) and standard list indentation (MD007).

• Support for glob patterns to handle large documentation sets, including recursive directory processing and custom exclusions.

• Integration with CI/CD pipelines to guarantee that all submitted markdown content meets established quality benchmarks before merging.

• Capability to handle stdin inputs and custom configuration files like .markdownlint.yaml to tailor checks to specific project needs.

• The skill strictly follows the project configuration defined in .markdownlint.yaml; always verify project-specific rules such as the allowance of inline HTML (MD033) or the disabling of line length restrictions (MD013) before making changes.

• Use the --fix flag for bulk resolution of style violations, but review changes to ensure intentional formatting is preserved.

• Always specify languages for code blocks (e.g., python, bash, json) to satisfy the MD040 requirement.

• Use the # character for file exclusion patterns (e.g., #node_modules) to ensure cross-platform compatibility across Windows and Unix environments.

• The tool is highly efficient at handling standard Markdown files but should be used in conjunction with other documentation tools like Vale for grammar and style checks.