md-janitor

Enforce consistent Markdown style and structure across a docs/ directory.

14|Updated Feb 15, 2026
One-click install
npx skills add https://github.com/tae0y/python-project-template --skill md-janitor
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: md-janitor
Source: https://github.com/tae0y/python-project-template/tree/main/.claude/skills/md-janitor
Command: npx skills add https://github.com/tae0y/python-project-template --skill md-janitor

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enforces a consistent Markdown style and structure for documentation.

Core Features & Use Cases

  • Enforces file naming conventions like kebab-case.md and appropriate prefixes (setup-, guide-, or root-level conventions)
  • Provides a standard document structure with a title, intro sentence, prerequisites, and optional remove section for maintainability
  • Guides language style, formatting rules, and prohibits inline code fences and problematic headings
  • Use cases include creating new docs, reviewing or fixing existing ones, renaming files, or restructuring a docs/ directory

Quick Start

Run the md-janitor workflow on your docs/ folder to audit and align all Markdown files to the standard style.

Frequently Asked Questions about md-janitor

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

FAQPage Schema
How do I enforce consistent Markdown style and naming conventions across my docs directory?▼

To enforce consistent Markdown style, run an automated workflow that audits your docs directory and aligns files to a standard structure, applying kebab-case file names and prescribed document layouts.

What is the standard document structure for maintaining Markdown readability?▼

Standard Markdown document structure requires a title, an introductory sentence, a prerequisites section, and an optional removal section for maintainability, while prohibiting problematic headings and inline code fences.

How do I fix existing Markdown files that do not follow kebab-case naming conventions?▼

Fix non-compliant Markdown files by running a review and restructuring workflow that renames files to kebab-case and applies appropriate prefixes like setup- or guide- based on root-level directory conventions.

Can I use Markdown linting to check frontmatter definitions and formatting rules?▼

Yes, Markdown linting checks frontmatter definitions and enforces language style and formatting rules to ensure documentation remains clean, readable, and consistently structured across the project.

What are the limitations when restructuring a docs directory for Markdown style consistency?▼

Restructuring Markdown documentation is limited to applying prescribed file naming conventions and document layouts, meaning custom structural formats or unsupported prefixes may not be retained during the alignment process.