免费在 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).

中文简介正在准备中。当前显示原文说明。

NetFabric/NetFabric.Numerics星标 36(GitHub 36 + cccskills 0)

实测评分未实测

查看安装方法

包含的文件（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（原文）

安装前可以查看交给 AI 代理的指令内容。

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

File	Purpose
SKILL.md	Top pitfalls, workflow, reference table
references/headings-and-structure.md	Heading hierarchy, spacing, single-title rule
references/lists-and-code-blocks.md	List markers/indentation, fenced code languages and spacing
references/tables.md	Table pipe/column consistency, blank-line spacing
references/links-images-and-whitespace.md	Link/image conventions, whitespace hygiene

Top Pitfalls

Pitfall	Fix
Fenced code block with no language tag	Always tag it: ```bash, ```json, ```text for plain/pseudocode
Heading with no blank line above/below	Blank 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 document	Exactly one H1 as the title; everything else H2+
Table rows padded inconsistently	Pick one column style and use it for every row, including the separator
Mixed list markers (`-`, `*`, `+`) in one document	Pick one marker and use it throughout
List/table/code block missing surrounding blank lines	Blank line before and after each block
Bare URL with no link syntax	Wrap it: `<https://...>` or `[text](https://...)`
Trailing whitespace or hard tabs	Strip 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

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

Workflow: Reviewing Existing Markdown

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

Reference Files

File	Load When
references/headings-and-structure.md	Structuring or fixing a document's heading hierarchy
references/lists-and-code-blocks.md	Writing/reviewing lists or fenced code blocks
references/tables.md	Writing/reviewing Markdown tables
references/links-images-and-whitespace.md	Writing/reviewing links, images, or general whitespace

评价

还没有评价。欢迎分享你的使用感受。

无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

同一仓库的技能

3d-rotation-theory

免费

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

中文简介正在准备中。当前显示原文说明。