doc-qa
CommunityEnsure Markdown documentation quality with linting and validation.
Authornist0
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the process of linting and validating Markdown documentation, checking for broken links, heading hierarchy, code block fences, and providing a fix list.
Core Features & Use Cases
- Markdown Linting: Checks for common Markdown formatting issues like trailing spaces, heading levels, and code block language identifiers.
- Broken Link Checking: Validates internal and external links within the documentation.
- Heading Hierarchy Verification: Ensures proper heading structure for better navigation.
- Code Block Language Identification: Ensures all code blocks have the correct language identifiers for syntax highlighting.
- Fix List Production: Generates a list of issues with actionable fixes for each file.
- CI Integration: Can be integrated into CI pipelines for ongoing documentation quality checks.
Quick Start
Run the doc-qa skill on your Markdown documentation with the command: python scripts/validate-markdown-lint.py
Dependency Matrix
Required Modules
markdownlint-cli2link-checker.py
Components
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: doc-qa Download link: https://github.com/nist0/CoDev/archive/main.zip#doc-qa Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.