markdown-conventions

Standardize Markdown documentation with ATX headings, code fences, and frontmatter.

Updated Feb 7, 2026
One-click install
npx skills add https://github.com/jsamuelsen11/claude-config --skill markdown-conventions-jsamuelsen11
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-conventions
Source: https://github.com/jsamuelsen11/claude-config/tree/main/plugins/ccfg-markdown/skills/markdown-conventions
Command: npx skills add https://github.com/jsamuelsen11/claude-config --skill markdown-conventions-jsamuelsen11

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown is a widely used format but projects often diverge in formatting and style, leading to inconsistent docs and rendering issues across repositories.

Core Features & Use Cases

  • Enforces ATX headings, consistent code fences with language tags, and compliant frontmatter to maintain readable structure.
  • Guides on link usage, list formatting, and table rules to ensure navigable documentation.
  • Use Case: When multiple contributors work on a shared README or wiki, this skill helps align style and render correctness.

Quick Start

Apply these conventions to new and existing Markdown files to maintain cohesive documentation across projects.

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 multiple project contributors?

To enforce consistent markdown formatting, apply standardized conventions like ATX headings, language-tagged code fences, and compliant frontmatter to align shared READMEs and wikis across multiple contributors.

What are standard markdown conventions for structuring project documentation?

Standard markdown conventions for structuring project documentation include using ATX headings, consistent code fences with language tags, and clear link and list formatting to maintain readable, navigable structure.

How do I standardize markdown code blocks and headings in a large repository?

You standardize markdown code blocks and headings in a large repository by enforcing ATX heading formats and requiring language tags on all fenced code blocks to ensure consistent rendering across teams.

Does this approach apply to both new and existing markdown files?

Yes, this approach applies to both new and existing markdown files, allowing you to apply documentation conventions retrospectively to fix rendering issues and maintain cohesive style across projects.

What is the best way to lint markdown style in a shared wiki?

The best way to lint markdown style in a shared wiki is to enforce specific formatting rules for links, lists, and frontmatter, ensuring navigable documentation and render correctness across multiple authors.

Why do my markdown tables and lists render incorrectly across different repositories?

Markdown tables and lists render incorrectly across repositories because projects diverge in formatting style; applying table rules and consistent list formatting resolves these rendering issues and aligns project conventions.