Skip to content

NetFabric/NetFabric.Numerics / .agents/skills/markdown-best-practices

markdown-best-practices

Verified

ALWAYS 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).

references/headings-and-structure.md

View on GitHub
# Headings & Structure

## Document Title

- The first line of a file SHOULD be a single H1 that serves as the document's title. An `<h1>`-equivalent image or badge is also acceptable for a README that leads with a logo.
- Use exactly one H1 per document — it's the title. Every subsequent heading is H2 or deeper.

## Heading Hierarchy

Increment by exactly one level at a time. Never skip a level.

```markdown
<!-- Wrong: skips H2 -->
# Heading 1
### Heading 3

<!-- Right: increments by one -->
# Heading 1
## Heading 2
### Heading 3
```

## Heading Style

- Use ATX style (`#`, `##`, `###`, ...) consistently. Avoid Setext style (underlining text with `===`/`---`) — it only supports two levels and reads worse in a diff.
- Exactly one space between the `#` markers and the heading text:

```markdown
<!-- Wrong -->
#Heading
##  Heading

<!-- Right -->
# Heading
## Heading
```

- Headings must start at column 0 (not indented), except inside a blockquote (`> # Heading`) — an indented heading is parsed as regular text, not a heading.

## Spacing

Every heading needs a blank line before it and a blank line after it, except at the very start or end of the file:

```markdown
<!-- Wrong -->
Some text
## Heading
More text

<!-- Right -->
Some text

## Heading

More text
```

Some parsers render a heading with no blank line before it as plain text instead — this isn't just a style preference.

## Content Rules

- Don't repeat identical heading text at the same level — parsers generate anchors from heading text, and duplicates collide. Repeating a heading under different parents is fine (e.g., a recurring "### Notes" subheading under each "## 1.0.0" / "## 2.0.0" release in a changelog).
- Don't end a heading with punctuation: `# Setup.` → `# Setup`. A trailing `?` is fine for FAQ-style headings.
- Don't fake a heading with bold or italic text used as a section break — use a real heading so tools can parse the document's structure:

```markdown
<!-- Wrong: emphasis instead of a heading -->
**Setup**

Steps go here.

<!-- Right -->
## Setup

Steps go here.
```
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: 471kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall
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: 198kUpdated Claude CodeCodexUnverifiedInstall
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: 198kUpdated Claude CodeCodexVerifiedInstall