← ClaudeAtlas

markdownlisted

Use when authoring, editing, or reviewing Markdown files — covers proper syntax, lint rules, formatting best practices, tables, code blocks, and deprecated patterns to avoid
Domush/react-skills · ★ 1 · Data & Documents · score 59
Install: claude install-skill Domush/react-skills
# Markdown Authoring Reference skill for writing correct, clean, lint-compliant Markdown. Covers CommonMark, GitHub Flavored Markdown (GFM), markdownlint rules, best practices, and common mistakes. **Sub-files for detailed reference:** - `markdown-reference.md` — Advanced examples, edge cases, tables, nested structures, GitHub extensions - `documentation/markdownlint-rules.md` — Complete markdownlint rule list with IDs, aliases, tags, inline config - `documentation/markdown-syntax-guide.md` — Full CommonMark and GFM syntax reference --- ## Best Practices Summary ### Document Structure - **One H1 per document** (MD025) — use `#` for the document title only - **Increment headings by one** (MD001) — never skip levels (e.g., `##` → `####`) - **Start with a heading** (MD041) — first line should be `#` (unless YAML front matter) - **End with a newline** (MD047) — single trailing newline at end of file - **Use ATX headings** (MD003) — `# Heading` style, not setext underline style ### Spacing - **Blank lines around block elements** — headings (MD022), lists (MD032), code blocks (MD031), tables (MD058) - **No multiple blank lines** (MD012) — only one blank line between elements - **No trailing spaces** (MD009) — remove invisible trailing whitespace - **No hard tabs** (MD010) — use spaces for indentation - **Space after `#`** (MD018) — `# Heading` not `#Heading` ### Lists - **Consistent markers** (MD004) — use `-` for unordered lists, don't mix with `*` or `+` - **Consistent