check-docs

Lint Markdown docs and blog posts for frontmatter, broken links, and heading structure.

1|Updated Jul 17, 2025
One-click install
npx skills add https://github.com/whatsper/texterdocs --skill check-docs-whatsper
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/whatsper/texterdocs/tree/main/.claude/skills/check-docs
Command: npx skills add https://github.com/whatsper/texterdocs --skill check-docs-whatsper

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Lint and validate Markdown documentation to ensure consistent frontmatter, valid links, proper heading structure, and safe formatting across docs and blog posts.

Core Features & Use Cases

  • Frontmatter validation and consistency checks across docs and blog posts
  • Broken-link detection within docs/blogs with guidance on resolution
  • Admonition syntax and heading structure validation
  • Optional safe auto-fixes for non-destructive changes

Quick Start

Run the lint pass on your docs to surface issues and apply safe, auto-fixable corrections.

Frequently Asked Questions about check-docs

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

FAQPage Schema
How do I lint Markdown docs to enforce frontmatter and structure?▼

Lint Markdown docs by scanning files to validate frontmatter presence, detect broken links, and enforce consistent heading structure. The tool reports issues with guidance and applies safe, non-destructive auto-fixes.

How do I check for broken links in my Markdown blog posts?▼

Check for broken links in Markdown blog posts by running a link detection scan. The linter identifies invalid links and provides guidance on resolution without applying changes unless explicitly confirmed.

What is the best way to auto-fix Markdown formatting issues safely?▼

Auto-fix Markdown formatting safely by running scoped checks that only correct non-destructive issues. The linter preserves project conventions and applies no changes to links or headings without explicit confirmation.

Can I validate admonition syntax and heading structure in Markdown docs?▼

Validate admonition syntax and heading structure in Markdown docs by running a lint pass. The linter scans docs and blog directories to report structural inconsistencies and ensure formatting compliance.

Why does my Markdown linter not fix broken links automatically?▼

Markdown linters do not fix broken links automatically to prevent destructive changes. The tool identifies invalid links and provides resolution guidance, requiring explicit confirmation before modifying links or headings.

Do I need to install dependencies to lint Markdown files for consistency?▼

No dependencies are required to lint Markdown files for consistency. The linter directly scans docs and blog Markdown files to validate frontmatter, detect broken links, and enforce structure without external packages.