qmd-consistency-check
Checks QMD files for consistency, variable references, and cross-format links. Use after batch editing multiple files or before commits.
When & Why to Use This Skill
This Claude skill automates the validation of Quarto Markdown (QMD) files to ensure documentation consistency and structural integrity. It performs comprehensive checks on variable references, cross-file links, and formatting standards, helping technical writers and developers maintain high-quality, error-free documentation sets for complex projects.
Use Cases
- Pre-commit validation: Automatically verify QMD file consistency and link integrity before pushing documentation updates to a version control repository.
- Post-batch editing: Quickly identify broken variable references or incorrect file extensions after performing large-scale search-and-replace operations across multiple files.
- Quarto project maintenance: Ensure all referenced files are correctly listed in the _quarto.yml configuration and adhere to cross-format compatibility standards.
- Automated style linting: Detect and flag hardcoded values or prohibited characters like em-dashes to maintain a professional and consistent technical writing style.
| name | qmd-consistency-check |
|---|---|
| description | Checks QMD files for consistency, variable references, and cross-format links. Use after batch editing multiple files or before commits. |
QMD Consistency Checker
What This Does
Validates entire book for:
- Variable references (all
{{< var ... >}}are valid) - Cross-file links use
.qmdextensions - Referenced files exist in
_quarto.yml - No hardcoded values that should be variables
- Consistent formatting and style
- No em-dashes (should be periods, commas, or parentheses)
Process
1. Find all QMD files
find knowledge -name "*.qmd" -type f
2. Check all variable references
grep -r "{{< var" --include="*.qmd" knowledge/
Compare against _variables.yml to verify all variables exist.
3. Check cross-file links
grep -r "\](.*\.html" --include="*.qmd" knowledge/
All links should use .qmd not .html for cross-format compatibility.
4. Find hardcoded values
grep -rE '\$[0-9,]+(\.[0-9]+)?[MBK]?' --include="*.qmd" knowledge/
Check if these values exist as variables in _variables.yml.
5. Check for em-dashes
grep -r "—" --include="*.qmd" knowledge/
Linter requires replacing em-dashes with periods, commas, or parentheses.
Expected Outcome
After running this skill:
- All variable references are valid
- All links use cross-format compatible
.qmdextensions - No broken cross-file references
- Hardcoded values are flagged for review
- Style issues are identified