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/lists-and-code-blocks.md

View on GitHub
# Lists & Code Blocks

## List Markers

Pick one unordered-list marker (`-`, `*`, or `+`) and use it for every list item at the same level throughout a document — don't mix them:

```markdown
<!-- Wrong -->
* Item 1
- Item 2
+ Item 3

<!-- Right -->
- Item 1
- Item 2
- Item 3
```

For ordered lists, either number every item `1.` (renders as an auto-incrementing list — easiest to maintain, since inserting an item never requires renumbering) or number them truly sequentially (`1.`, `2.`, `3.`). Don't skip or restart numbers.

## Indentation

- Indent nested list items by exactly 2 spaces under their parent marker.
- Sibling items at the same list level must share identical indentation — a stray extra space breaks how the parser groups them:

```markdown
<!-- Wrong: misaligned sibling -->
- Item 1
  - Nested item
   - Misaligned nested item

<!-- Right -->
- Item 1
  - Nested item
  - Nested item
```

## Spacing After Markers

Exactly one space between a list marker and its text:

```markdown
<!-- Wrong -->
-  Two spaces
-No space

<!-- Right -->
- One space
```

## Blank Lines Around Blocks

Lists and fenced code blocks each need a blank line before and after them, except at the very start/end of a document or when a code block is nested inside a list item's own content:

```markdown
<!-- Wrong -->
Some text
- List item
- List item
Some more text

<!-- Right -->
Some text

- List item
- List item

Some more text
```

## Fenced Code Blocks

- Always specify a language after the opening fence: `` ```bash ``, `` ```json ``, `` ```yaml ``, `` ```python ``. Use `` ```text `` for plain text, pseudocode, or sample output that isn't real code — never leave the fence untagged.
- Prefer fenced code blocks (triple backticks) over indented code blocks — fences are unambiguous, easy to nest inside lists, and clearly mark where code starts and ends.
- Use backtick fences (`` ``` ``) consistently. Reserve tilde fences (`~~~`) only for the rare case where the code content itself needs to contain a backtick fence.
- Don't pad inline code spans with extra spaces: `` `code` ``, not `` ` code ` ``.
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