skills.rest
kaynetik
kaynetikCOMMUNITY
Explore all skills by this author →
Website𝕏@kaynetikGitHub

markdown-documentation

Enforce consistent Markdown documentation standards for technical projects.

1|Updated Mar 20, 2026
Search Tags:#linting#documentation#markdown#mermaid#style-guide#technical-writing#gfm
One-click install
npx skills add https://github.com/kaynetik/skills --skill markdown-documentation-kaynetik
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdown-documentation
Source: https://github.com/kaynetik/skills/tree/main/markdown-documentation
Command: npx skills add https://github.com/kaynetik/skills --skill markdown-documentation-kaynetik

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Technical documentation often suffers from inconsistent heading structure, filler language, hidden Unicode artifacts, improper use of GitHub Flavored Markdown features, and accessibility issues; this Skill provides concrete rules to produce clear, consistent, and machine-safe Markdown that readers and tools can rely on.

Core Features & Use Cases

  • Heading hierarchy & structure: Enforce one H1 per document, correct nesting, and concise anchor-friendly headings.
  • No-AI-slop rules: Detect and prohibit filler phrases, emojis, smart quotes, zero-width characters, and decorative Unicode.
  • GFM guidance: Prescribe correct use of task lists, alerts, collapsible sections, Mermaid diagrams, tables, badges, and language-specified code fences.
  • Templates & references: Provide README, CONTRIBUTING, CHANGELOG, and API templates plus a syntax reference for consistent authoring.
  • Use Cases: Audit and rewrite README files, docs pages, changelogs, API docs, and contributing guides to meet accessibility and maintainability standards.

Quick Start

Audit the project's README and rewrite it to conform to these Markdown documentation standards, fixing headings, removing filler language, and ensuring GFM features and diagrams are used appropriately.

Frequently Asked Questions about markdown-documentation

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

FAQPage Schema
How do I enforce consistent heading hierarchy in Markdown documentation?▼

Consistent Markdown documentation requires enforcing one H1 per document, correct heading nesting, and concise anchor-friendly headings to ensure clear structure and accessibility for readers.

How do I remove hidden Unicode artifacts and AI filler from README files?▼

Removing Unicode artifacts and AI filler from README files requires detecting and prohibiting smart quotes, zero-width characters, decorative Unicode, emojis, and filler phrases to produce machine-safe Markdown.

What is the correct way to use GitHub Flavored Markdown features in technical docs?▼

Correct GitHub Flavored Markdown usage in technical docs involves applying task lists, alerts, collapsible sections, Mermaid diagrams, tables, badges, and language-specified code fences according to concrete style rules.

Does this Markdown linter support Mermaid diagrams and code block language specifications?▼

Yes, this Markdown linter supports Mermaid diagrams and code blocks by providing explicit guidance on their correct usage and requiring language specifications for all code fences to ensure proper rendering.

What templates are available for standardizing technical writing across project docs?▼

Available templates for standardizing technical writing include README, CONTRIBUTING, CHANGELOG, and API documentation templates, plus a syntax reference for consistent authoring across all project documentation.

How do I audit and rewrite a README to meet Markdown documentation standards?▼

To audit and rewrite a README to meet Markdown documentation standards, fix heading hierarchy, remove filler language and Unicode artifacts, and ensure GFM features like alerts and Mermaid diagrams are used appropriately.

Related Skills

Explore More Content & Communication Skills→
markpittmarkpitt
22

markdown-formatter

Formats Markdown documents to enforce consistent style and structure.

Community
Intermediate
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
mk-knight23mk-knight23
1

code-reviewer

Run static analysis and AI review on Python code to produce a severity-rated CODE_REVIEW.md report.

Community
Advanced
CygnusfearCygnusfear
5

writing-clearly-and-concisely

Apply Strunk's writing rules to improve prose clarity and concision.

Community
Basic