Skip to content
cccskills
FreePublished on GitHub

markdown-best-practices

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

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36 stars(GitHub 36 + cccskills 0)

Run score Not tested

See how to install

Files included (5)

  • SKILL.md4.4 KB
  • references/headings-and-structure.md2.0 KB
  • references/links-images-and-whitespace.md2.2 KB
  • references/lists-and-code-blocks.md2.1 KB
  • references/tables.md2.1 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Markdown Best Practices

Markdown renders differently across parsers when formatting is inconsistent or incomplete. These conventions keep documents portable across GitHub, static-site generators, and editor previews.

Anatomy

FilePurpose
SKILL.mdTop pitfalls, workflow, reference table
references/headings-and-structure.mdHeading hierarchy, spacing, single-title rule
references/lists-and-code-blocks.mdList markers/indentation, fenced code languages and spacing
references/tables.mdTable pipe/column consistency, blank-line spacing
references/links-images-and-whitespace.mdLink/image conventions, whitespace hygiene

Top Pitfalls

PitfallFix
Fenced code block with no language tagAlways tag it: ```bash, ```json, ```text for plain/pseudocode
Heading with no blank line above/belowBlank line before and after every heading
Heading levels skip (H1 → H3)Increment by exactly one level at a time
More than one H1 in a documentExactly one H1 as the title; everything else H2+
Table rows padded inconsistentlyPick one column style and use it for every row, including the separator
Mixed list markers (-, *, +) in one documentPick one marker and use it throughout
List/table/code block missing surrounding blank linesBlank line before and after each block
Bare URL with no link syntaxWrap it: <https://...> or [text](https://...)
Trailing whitespace or hard tabsStrip trailing spaces (except an intentional 2-space line break); use spaces, not tabs
Generic link text ("click here", "link")Use descriptive text, e.g. "the setup guide"

Workflow: Writing New Markdown

  1. Start with a single H1 title; every other heading is H2 or deeper, incrementing by one level at a time.
  2. Add a blank line before and after every heading, list, table, and fenced code block.
  3. Tag every fenced code block with a language (bash, json, yaml, text, ...).
  4. Pick one style each for list markers, emphasis (*/_), and table pipe padding — apply it document-wide.
  5. Give links descriptive text and images alt text; wrap bare URLs.
  6. End the file with exactly one trailing newline; no trailing whitespace.

Workflow: Reviewing Existing Markdown

  1. Scan headings top to bottom: one H1, no level skips, no duplicates, blank lines around each.
  2. Scan lists and tables for mixed markers, ragged indentation, or inconsistent pipe padding.
  3. Scan fenced code blocks for a missing language tag.
  4. Scan links for bare URLs, empty destinations, and generic text.
  5. Strip trailing whitespace and collapse multiple blank lines to one.

Reference Files

FileLoad When
references/headings-and-structure.mdStructuring or fixing a document's heading hierarchy
references/lists-and-code-blocks.mdWriting/reviewing lists or fenced code blocks
references/tables.mdWriting/reviewing Markdown tables
references/links-images-and-whitespace.mdWriting/reviewing links, images, or general whitespace

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

3d-rotation-theory

Free

Abstract math for 3D rotation representations and conversions. USE FOR: understanding axis-angle representation; Euler angles (yaw/pitch/roll, convention choices); rotation matrices (SO(3)); quaternion-based rotation; converting between representations; identifying and avoiding gimbal lock; composing rotations; half-angle formula; right-hand rule. DO NOT USE FOR: quaternion arithmetic details (use quaternion-algebra); slerp/lerp interpolation (use interpolation-on-manifolds); coordinate system definitions (use coordinate-system-conversions).

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36Updated Aug 10, 2026

agent-graph-orchestration

Free

Design and scaffold multi-agent squads/swarms using the graph orchestration pattern (nodes = agents, edges = dependencies/data flow). USE FOR: designing a coordination topology for a multi-agent squad (sequential pipeline, parallel fan-out/aggregation, branching, feedback loop, cyclic); building an orchestrator agent that delegates to specialist agents; setting up an adversarial/tribunal code or document review with independent reviewers; scaffolding a squad's agent files for a target coding-agent harness (e.g. Copilot CLI or Claude Code custom agents). DO NOT USE FOR: authoring a single agent's frontmatter/prompt body (use copilot-cli-custom-agents, claude-code-custom-agents, or the target harness's own skill); SKILL.md authoring (use create-skill); ad-hoc multi-agent chat with no explicit topology.

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36Updated Aug 10, 2026

agent-harness-logs

Free

Find, inspect, query, redact, and troubleshoot logs, transcripts, sessions, and OpenTelemetry data from coding-agent harnesses on Windows, macOS, Linux, and WSL. USE FOR: GitHub Copilot in VS Code; Copilot CLI; Claude Code; OpenAI Codex; Gemini CLI; OpenCode; Cursor, Windsurf, Kiro, or other VS Code-family editors; locating log files; diagnosing tool or model failures; correlating turns, subagents, and tool calls; querying JSONL, plaintext, or SQLite without spending model tokens; preparing sanitized diagnostics. DO NOT USE FOR: application logs unrelated to coding agents; uploading raw logs; treating unstable transcript schemas as public APIs.

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36Updated Aug 10, 2026

agents-md

Free

Author and maintain AGENTS.md files — the open, tool-agnostic format for giving coding agents project context. Use when: creating AGENTS.md; writing an agent instructions file; root or nested AGENTS.md for monorepos; migrating CLAUDE.md, AGENT.md, .cursor/rules, or copilot-instructions.md to AGENTS.md; greenfield project setup before code exists; brownfield onboarding for an existing codebase; documenting build/test/lint commands, code style, PR/commit conventions, and security considerations for agents; AGENTS.md discovery and precedence rules. Works for any language, framework, or project size. DO NOT USE FOR: authoring SKILL.md skill files (use create-skill); APM package/plugin authoring (use apm-producer); language-specific style rules (use language skills e.g. csharp-best-practices).

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36Updated Aug 10, 2026

angles-and-circular-arithmetic

Free

Abstract math for angle measurement, unit systems, and circular arithmetic. USE FOR: implementing angle types; converting between degrees/radians/gradians/revolutions; reducing angles to canonical range [0, Full); computing reference angles and quadrants; implementing safe modular arithmetic with negative inputs; angle addition and subtraction; classifying angles by sign and size. DO NOT USE FOR: trigonometric functions (use trigonometric-functions); coordinate conversions (use coordinate-system-conversions); interpolation (use interpolation-on-manifolds).

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36Updated Aug 10, 2026

claude-code-custom-agents

Free

Create and maintain Claude Code custom subagents (.claude/agents/*.md files). USE FOR: authoring project (.claude/agents/) or user (~/.claude/agents/) subagent files; frontmatter fields (name, description, tools, disallowedTools, model, permissionMode, maxTurns, skills, mcpServers, hooks, memory, background, effort, isolation, color, initialPrompt); writing descriptions that drive automatic delegation and 'use proactively' phrasing; invoking subagents via natural language, @-mention, session-wide --agent, or the Agent tool; restricting which subagent types a coordinator can spawn with Agent(name1, name2); nested subagents and depth limits; built-in subagents (Explore, Plan, general-purpose, claude); troubleshooting a subagent that won't load or isn't invoked. DO NOT USE FOR: GitHub Copilot CLI custom agents (use copilot-cli-custom-agents); agent teams/teammates (a different, session-spanning feature); MCP server authoring; SKILL.md authoring (use create-skill).

The English summary is being prepared. Showing the original description.

NetFabric/NetFabric.Numerics36Updated Aug 10, 2026

See all skills by NetFabric

Report a problem with this skill