rm-markdown

Apply MarkdownLint rules MD001-MD059 to correct Markdown content errors.

Updated Nov 11, 2023
One-click install
npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill rm-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rm-markdown
Source: https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb/tree/main/.opencode/skills/redmuffin-standards/rm-markdown
Command: npx skills add https://github.com/michaelvolz/redmuffin.Blazor.StaticWeb --skill rm-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enforces consistent Markdown content standards so documentation authors and assistants avoid formatting errors and MarkdownLint violations that reduce readability.

Core Features & Use Cases

  • Heading discipline: Verify proper heading levels, ensure only one H1, avoid duplicates, and keep headings clean of trailing punctuation.
  • List, spacing, and link hygiene: Standardize list markers, blank lines, whitespace, and descriptive link syntax while limiting line length for readability.
  • Lint comparison: Apply MD001 through MD059 guidance when writing new Markdown or fixing linting errors before publishing documentation.

Quick Start

Use the rm-markdown skill to review my Markdown document and fix any violations of the MD001-MD059 rules.

Frequently Asked Questions about rm-markdown

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

FAQPage Schema
How do I fix MarkdownLint violations in my documentation?

MarkdownLint rules MD001 through MD059 are enforced to correct formatting errors in your documentation. This process standardizes heading hierarchy, list markers, whitespace, and link syntax to ensure consistent, readable Markdown files.

What do MarkdownLint rules MD001 through MD059 cover?

MarkdownLint rules MD001 through MD059 cover heading discipline, list hygiene, spacing, and link formatting. They enforce proper heading levels, single H1 usage, descriptive link syntax, line length limits, and fenced code block formatting for documentation authors.

How do I enforce a consistent heading hierarchy in Markdown files?

To enforce a consistent heading hierarchy in Markdown files, apply linting rules that verify proper heading levels, ensure only one H1 per document, avoid duplicate headings, and keep headings clean of trailing punctuation.

Can I standardize list markers and whitespace in Markdown automatically?

Yes, you can standardize list markers and whitespace in Markdown by applying formatting guidelines. This process standardizes list markers, adds required blank lines, enforces whitespace rules, and limits line length for improved readability.

How do I format bare URLs as descriptive links in Markdown?

To format bare URLs as descriptive links in Markdown, apply linting rules that enforce descriptive link syntax. This replaces raw URLs with properly formatted link text, improving both readability and documentation standards compliance.