Does it validate the content inside the sections?

It specifically checks for the presence of the header and ensures that the 'Installation' section contains at least one code block.

Does it support monorepos with multiple README files?

Yes, it recursively searches the repository for all files matching the README*.md pattern, excluding system directories like .git.

Can it check if my project badges are broken?

Yes, the skill can use WebFetch on-demand to check the reachability of badge image URLs found within your documentation.

How does the skill identify which sections are required?

The skill looks for a .readme-validator.yaml file in the directory tree. If none is found, it uses defaults requiring 'Installation' and 'Usage' sections.

README Validator

Name: README Validator
Author: JacobPEvans

byJacobPEvans

•

学习与文档

Validates repository README files to ensure documentation consistency, required sections, and functional code blocks.

The README Validator skill automates the process of auditing documentation across an entire repository. It scans for all README files and verifies them against a set of standards—either defined in a custom configuration file or using sensible defaults—to ensure critical sections like Installation and Usage are present. Beyond simple header checks, the skill verifies that installation instructions contain actual code blocks and can even perform live reachability checks on badges using WebFetch, making it indispensable for maintaining high-quality open-source projects and internal documentation.

主要功能

01Customizable validation rules via .readme-validator.yaml configuration

02Automatic discovery of all README files throughout the repository tree

03Formatted summary reports detailing the status and issues for every file

04Live badge URL reachability testing using WebFetch integration

05Verification of required sections like Installation, Usage, and License

062 GitHub stars

使用场景

01Maintaining documentation standards across large monorepos with multiple packages

02Standardizing documentation structure for consistency across a development team

03Performing pre-release audits to ensure open-source repositories are user-ready

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jacobpevans/claude-code-plugins validate-readme

For use in Claude.ai and ChatGPT

主要功能

01Customizable validation rules via .readme-validator.yaml configuration

02Automatic discovery of all README files throughout the repository tree

03Formatted summary reports detailing the status and issues for every file

04Live badge URL reachability testing using WebFetch integration

05Verification of required sections like Installation, Usage, and License

062 GitHub stars

使用场景

01Maintaining documentation standards across large monorepos with multiple packages

02Standardizing documentation structure for consistency across a development team

03Performing pre-release audits to ensure open-source repositories are user-ready

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jacobpevans/claude-code-plugins validate-readme

For use in Claude.ai and ChatGPT