NetFabric/NetFabric.Numerics / .agents/skills/markdown-best-practices
markdown-best-practices
VerifiedALWAYS use this skill whenever creating, editing, or reviewing any Markdown (.md) file — README.md, SKILL.md, AGENTS.md, CONTRIBUTING.md, changelogs, or any other Markdown documentation — even for small edits. Write and review Markdown files for consistent, correctly-rendering formatting: heading hierarchy and spacing, list marker and indentation consistency, fenced code block languages and blank-line spacing, table pipe and column consistency, link and image conventions, and whitespace hygiene. USE FOR: authoring or reviewing README.md, SKILL.md, AGENTS.md, or any Markdown documentation; fixing inconsistent headings, lists, code fences, or tables; fixing issues reported by Markdown linters such as markdownlint; choosing link/image/emphasis styles; general Markdown formatting conventions. DO NOT USE FOR: non-Markdown formats (reStructuredText, AsciiDoc); prose tone or content-quality review; the SKILL.md authoring workflow itself (see create-skill); AGENTS.md content structure (see agents-md).
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 4.4 KB |
| references/headings-and-structure.md | markdown | 2.0 KB |
| references/links-images-and-whitespace.md | markdown | 2.2 KB |
| references/lists-and-code-blocks.md | markdown | 2.1 KB |
| references/tables.md | markdown | 2.1 KB |
references/tables.md
View on GitHub# Tables
## Structure
Every row — header, separator, and each data row — must have the same number of cells:
```markdown
<!-- Wrong: second row has one cell too few, third has one too many -->
| Header | Header |
| --- | --- |
| Cell |
| Cell | Cell | Cell |
<!-- Right -->
| Header | Header |
| --- | --- |
| Cell | Cell |
| Cell | Cell |
```
## Pipe Style
Use a leading and trailing `|` on every row. It's the clearest, most portable form and avoids ambiguity with text immediately before or after the table.
## Column Padding — Pick One Style, Apply It To Every Row
Three padding styles all render identically. Pick one **per table** and use it consistently for the header, separator, and every data row:
| Style | Example row | When to use |
| --- | --- | --- |
| Tight | `\|Col\|Col\|` / `\|---\|---\|` | Short cell content, minimal diff noise |
| Compact | `\| Col \| Col \|` / `\| --- \| --- \|` | Default choice — one space of padding, easy to hand-edit even with long cell text |
| Aligned | cells padded so every `\|` lines up vertically down the column | Small tables with short, similar-length content you're willing to re-pad by hand on every edit |
Compact is the safest default: unlike Aligned, it never needs the whole table re-padded just because one cell's content got longer or shorter.
Never mix styles within one table — a padded header row with an unpadded separator row (or vice versa) is the most common way this breaks:
```markdown
<!-- Wrong: header is padded (Compact), separator is not (Tight) -->
| Skill | Description |
|---|---|
| name | text |
<!-- Right: Compact throughout -->
| Skill | Description |
| --- | --- |
| name | text |
```
## Spacing
A table needs a blank line before it and a blank line after it — text immediately following a table with no blank line is parsed as part of the table, not a new paragraph:
```markdown
<!-- Wrong -->
Some text
| Header | Header |
| --- | --- |
| Cell | Cell |
This line is swallowed into the table
<!-- Right -->
Some text
| Header | Header |
| --- | --- |
| Cell | Cell |
This line is a normal paragraph
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 198k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |