markdown

Format Markdown files with consistent headings, lists, tables, and links.

Updated May 9, 2020

Search Tags:#documentation #markdown #formatting #markdownlint #style-guide #gfm #commonmark

Ready to run

npx skills add https://github.com/Fenntasy/dotfiles --skill markdown-fenntasy

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown
Source: https://github.com/Fenntasy/dotfiles/tree/main/claude/skills/markdown
Command: npx skills add https://github.com/Fenntasy/dotfiles --skill markdown-fenntasy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Markdown formatting and structure often diverge across files. This guide provides a unified set of conventions to make writing and reviewing Markdown easier, more readable, and reliably rendered across projects.

Core Features & Use Cases

Consistent headings, lists, tables, code blocks, and links
Anti-patterns avoidance and whitespace discipline
Use cases include documents, READMEs, CLAUDE.md, memory notes, and memory or wiki pages where stable formatting matters.

Quick Start

Apply these Markdown conventions to your next documentation file.

Frequently Asked Questions about markdown

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

FAQPage Schema

How do I enforce consistent Markdown formatting across multiple documentation files?▼

Consistent Markdown formatting is achieved by applying unified conventions for headings, lists, tables, and links. This ensures documentation remains readable and reliably rendered across projects using CommonMark and GFM compatibility.

What's the best way to avoid anti-patterns and whitespace issues in Markdown?▼

Avoiding Markdown anti-patterns and whitespace issues requires applying style-guide rules based on markdownlint. This enforces whitespace discipline and structural consistency while ensuring formatting changes preserve the original semantic content.

Does this Markdown formatting approach support GitHub Flavored Markdown (GFM) and CommonMark?▼

Yes, this Markdown formatting approach explicitly enforces compatibility with both CommonMark and GitHub Flavored Markdown (GFM). It applies conventions that ensure stable formatting and reliable rendering for READMEs and memory notes across these standards.

How do I apply markdownlint style rules when reviewing Markdown files?▼

Applying markdownlint style rules involves checking Markdown files against established conventions for structure and formatting. This process handles headings, lists, and code blocks while actively avoiding anti-patterns to maintain documentation quality.

Can I use this to standardize formatting for CLAUDE.md and memory notes?▼

Yes, you can standardize formatting for CLAUDE.md and memory notes. The conventions apply to writing or reviewing these specific files, ensuring stable formatting and structure without altering their underlying semantic content.