util-docs-lint

Validates and formats markdown files using dprint, vale, lychee, and GitHub Actions.

Updated Apr 8, 2026
One-click install
npx skills add https://github.com/VictorHueni/homemade-claude-kit --skill util-docs-lint
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: util-docs-lint
Source: https://github.com/VictorHueni/homemade-claude-kit/tree/main/skills/util-docs-lint
Command: npx skills add https://github.com/VictorHueni/homemade-claude-kit --skill util-docs-lint

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires dprint, vale, lychee, and includes scripts (resource) and assets (resource) components.

What problem does it solve?

This Skill addresses the quality, formatting, and style issues of markdown documents by utilizing various tools and checks.

Core Features & Use Cases

  • Formatting and Style: Ensures consistency in formatting and adheres to specific prose styles using dprint and vale.
  • Link Checking: Verifies the integrity of all links in markdown documents.
  • Audit and Enforcement: Provides audit and enforcement modes for reviewing and applying changes, respectively.
  • CI Integration: Integrates with GitHub Actions for continuous integration checks.

Quick Start

Run 'docs-lint.sh' in the project root to audit markdown document quality in the 'docs/' directory.

Frequently Asked Questions about util-docs-lint

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check markdown formatting and style consistency in my documentation?

To check markdown formatting and style consistency, you can run a local script that audits your docs directory using dprint and vale to validate document quality and apply prose style rules.

What is the best way to automate markdown link checking in a CI pipeline?

The best way to automate markdown link checking in CI is integrating a local-first toolchain with GitHub Actions, using lychee to verify link integrity automatically during continuous integration checks.

How do I enforce prose style rules and glossary aliases in markdown files?

You can enforce prose style rules and glossary aliases in markdown files by configuring vale with project-specific definitions, running an enforcement script to apply the desired corrections.

Can I use dprint and vale together for markdown document quality audits?

Yes, you can use dprint and vale together for markdown document quality audits, running them in audit mode to review formatting and style issues before applying changes in enforcement mode.

Does this markdown linting toolchain support automated fixes for formatting issues?

Yes, the markdown linting toolchain supports automated fixes by switching from audit mode to enforcement mode, allowing dprint and vale to apply formatting and style corrections directly.