Back to list
bostonaholic

markdown-validation

by bostonaholic

A Claude Code plugin implementing the Research-Plan-Implement (RPI) framework for disciplined software engineering.

2🍴 0📅 Jan 15, 2026

SKILL.md


name: markdown-validation description: >- Validates markdown files using markdownlint after writing or editing. Invoke this skill after creating or modifying any markdown file to ensure consistent formatting and zero linting violations.

Markdown Validation

Validate markdown files after writing or editing them.

Iron Law

Always run markdownlint after writing markdown. Fix ALL errors before proceeding.

This is not optional. This is not negotiable. Markdown files that fail linting create inconsistency and maintenance burden.

Workflow

Write/Edit markdown file
        │
        ▼
Run markdownlint on file
        │
        ▼
    ┌───────────┐
    │  Errors?  │
    └───────────┘
        │
   ┌────┴────┐
   │         │
   ▼         ▼
  Yes        No
   │         │
   ▼         ▼
Fix errors  Done
   │
   ▼
Re-run markdownlint
   │
   ▼
(repeat until no errors)

Process

1. Run Validation

After writing or editing a markdown file, run:

markdownlint <file-path>

2. Interpret Results

No output: File passes validation. Proceed.

Error output: Fix each error before proceeding.

Common errors:

CodeIssueFix
MD001Heading level incrementUse sequential heading levels
MD009Trailing spacesRemove trailing whitespace
MD012Multiple blank linesUse single blank lines
MD022Headings need blank linesAdd blank line before/after
MD031Fenced code needs blanksAdd blank line before/after
MD032Lists need blank linesAdd blank line before/after list
MD034Bare URLUse proper link syntax
MD047No newline at end of fileAdd final newline

3. Fix Errors

For each error:

  1. Read the error message and line number
  2. Navigate to the specific location
  3. Apply the fix
  4. Re-run validation

Do not proceed until all errors are fixed.

4. Confirm Success

Only after markdownlint returns no errors:

Markdown validation passed for <file-path>.

Red Flags

These thoughts mean STOP - you are rationalizing:

ThoughtReality
"It's just a small formatting issue"Small issues compound into chaos
"I'll fix it later"Later never comes. Fix it now.
"The content is correct"Correct content with bad format
is still broken
"markdownlint is too strict"Consistency requires strictness
"This file is temporary"All files deserve quality
"I don't have time"Fixing later takes more time
"It's only one warning"One warning becomes ten

Integration Points

This skill is invoked by:

  • rpikit:writing-plans - After writing plan documents
  • rpikit:researching-codebase - After writing research documents
  • rpikit:brainstorming - After writing design documents
  • PostToolUse hooks - Automatically after Write/Edit on .md files

Requirements

markdownlint must be installed. Install via:

npm install -g markdownlint-cli

If markdownlint is not available, warn and proceed:

Warning: markdownlint not installed. Skipping validation.
Consider installing: npm install -g markdownlint-cli

Anti-Patterns

Skipping Validation

Wrong: Writing markdown and moving on without checking Right: Always run markdownlint after every markdown write/edit

Partial Fixes

Wrong: Fixing some errors and ignoring others Right: Fix ALL errors. Zero tolerance.

Disabling Rules

Wrong: Adding disable comments to bypass errors Right: Fix the underlying issue

Batch Validation

Wrong: Writing many files then validating all at once Right: Validate immediately after each file write/edit

Score

Total Score

75/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon