markdown-conventions

Standardize Markdown syntax and formatting across project documentation.

3|Updated May 12, 2026

Search Tags:#linting #documentation #markdown #formatting #style-guide #commonmark

Ready to run

npx skills add https://github.com/gao-hongnan/omniagents --skill markdown-conventions-gao-hongnan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-conventions
Source: https://github.com/gao-hongnan/omniagents/tree/main/plugins/writing/skills/markdown-conventions
Command: npx skills add https://github.com/gao-hongnan/omniagents --skill markdown-conventions-gao-hongnan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill eliminates inconsistencies in Markdown documentation by enforcing a unified syntax, heading structure, and formatting policy across project files.

Core Features & Use Cases

Syntax Standardization: Ensures CommonMark compliance, proper heading hierarchy, and consistent use of fenced code blocks.
Quality Assurance: Validates image alt text, link formatting, and table alignment to improve accessibility and readability.
Use Case: When preparing a large documentation suite, use this skill to automatically audit files for missing language tags in code blocks or improper heading nesting to ensure a professional, polished output.

Quick Start

Apply the markdown-conventions skill to audit and fix formatting issues in the current documentation directory.

Frequently Asked Questions about markdown-conventions

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

FAQPage Schema

How do I enforce CommonMark compliance and fix markdown formatting issues across project documentation?▼

To enforce CommonMark compliance and standardize markdown formatting, you can apply automated linting rules that audit heading hierarchy, prose wrapping, and fenced code block styling to ensure consistent documentation syntax.

What is the best way to standardize heading hierarchy and code block styling in a large documentation suite?▼

Standardizing heading hierarchy and code block styling in a documentation suite requires applying a unified style guide based on markdownlint rule sets and Prettier configuration to automatically audit and correct structural inconsistencies.

Why does my markdown documentation fail accessibility checks for image alt text and table alignment?▼

Markdown documentation fails accessibility checks when image alt text is missing or table alignment is improper; applying formatting conventions validates these elements to improve overall accessibility and readability.

Can I use markdownlint rule sets and Prettier configuration together to audit repository hygiene?▼

Yes, using markdownlint rule sets alongside Prettier configuration provides comprehensive quality assurance for repository hygiene by validating link formatting, heading nesting, and consistent prose wrapping across documentation files.

Does this markdown formatting approach work for technical writing and README files without external dependencies?▼

Yes, this markdown formatting approach works effectively for technical writing and README files without requiring external dependencies, applying CommonMark specifications directly to maintain professional and polished documentation output.