markdown-conventions

Enforce Markdown conventions for headings, code blocks, links, and tables.

Updated Jan 15, 2026
One-click install
npx skills add https://github.com/rory-data/copilot --skill markdown-conventions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-conventions
Source: https://github.com/rory-data/copilot/tree/main/skills/markdown-conventions
Command: npx skills add https://github.com/rory-data/copilot --skill markdown-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often suffers from inconsistent formatting and unclear structure. This skill defines and enforces standardized Markdown conventions to improve readability, maintainability, and quality across projects.

Core Features & Use Cases

  • Establishes rules for headings, lists, code blocks, links, images, tables, and line length.
  • Guides writers and reviewers to maintain a uniform style across READMEs, guides, and technical documents.
  • Use Case: Teams can quickly audit and fix Markdown files to meet a single, agreed-upon standard.

Quick Start

Follow these conventions when creating or editing Markdown documentation to ensure consistent structure.

Frequently Asked Questions about markdown-conventions

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

FAQPage Schema
How do I enforce consistent Markdown formatting across technical docs?

You can enforce consistent Markdown formatting by applying standardized conventions for headings, lists, code blocks, and tables to improve readability and maintainability across README files and knowledge bases.

What Markdown style rules should a documentation linting guide include?

A Markdown style guide should include rules for front matter presence, no H1 usage, language standards, fenced code blocks with language, descriptive links, proper table formatting, and a 400-character line limit.

How do I standardize README files to prevent inconsistent documentation structure?

To standardize README files, apply rules that enforce specific structure conventions like requiring front matter and prohibiting H1 tags, ensuring your documentation maintains a uniform style across projects.

Do I need a specific linter to check Markdown conventions for my knowledge base?

No specific linter is required as a dependency. You can apply these Markdown conventions directly when creating or editing technical documentation to ensure consistent structure and clear formatting.

Why should my Markdown documentation avoid using H1 headings?

Avoiding H1 headings enforces a standardized structure across technical docs, relying on other heading levels and front matter to maintain consistent formatting and improve documentation readability.