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/links-images-and-whitespace.md

View on GitHub
# Links, Images & Whitespace

## Links

- Correct syntax is `[text](url)` — never reversed as `(text)[url]`.
- No spaces just inside the brackets: `[text](url)`, not `[ text ](url)`.
- Give every link a real destination. `[text]()` and `[text](#)` are empty links that go nowhere.
- Write descriptive link text instead of generic text — screen readers often list links out of context, so "click here" or "link" gives no information on their own:

```markdown
<!-- Wrong -->
See [here](setup.md) for setup instructions.

<!-- Right -->
See the [setup instructions](setup.md).
```

- A same-document anchor link (`[text](#section)`) must match the target heading's generated anchor: lowercase the heading text, drop punctuation, and replace spaces with `-` (e.g. `## Setup Guide` → `#setup-guide`).
- Reference-style links (`[text][label]` with a `[label]: url` defined elsewhere) need the label defined exactly once. Delete unused reference definitions and don't leave a label undefined.
- Wrap bare URLs and email addresses in angle brackets or use proper link syntax — a naked URL isn't reliably turned into a clickable link by every renderer:

```markdown
<!-- Wrong -->
Visit https://example.com for details.

<!-- Right -->
Visit <https://example.com> for details.
```

## Images

Always include descriptive alt text — never leave it empty:

```markdown
<!-- Wrong -->
![](diagram.png)

<!-- Right -->
![Architecture diagram showing the request flow](diagram.png)
```

## Whitespace

- No trailing spaces at the end of a line, except exactly two spaces when a hard line break is intended.
- Use spaces for indentation, never hard tabs.
- Collapse multiple consecutive blank lines down to a single blank line.
- End every file with exactly one trailing newline — no trailing blank lines, and never omit the final newline.
- Don't pad emphasis markers with spaces: `**bold**`, not `** bold **`.

## Emphasis & Rules

- Pick one emphasis marker (`*italic*` or `_italic_`) and one strong marker (`**bold**` or `__bold__`), and use each consistently throughout a document.
- If a document uses horizontal rules, pick one style — `---` is the most portable — and use it consistently rather than mixing `---`, `***`, and `___`.
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: 472kUpdated 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