详细分析 ▾
运行时依赖
版本
- Initial release defining canonical markdown formatting conventions. - Covers hybrid 80-character line wrapping, heading styles, list spacing, and link conventions. - Specifies content types to wrap or not wrap in markdown. - Provides structural rules for blank lines, headings, and lists. - Recommends reference-style links when URLs cause lines to exceed 80 characters.
安装命令 点击复制
技能文档
Night Market Skill — ported from claude-night-market/leyline. For the full experience with agents, hooks, and commands, install the Claude Code plugin.
# Markdown Formatting Conventions
When To Use
- Writing or editing any markdown documentation
- Reviewing prose for line-wrapping compliance
- Generating markdown from plugins (scribe, sanctum, etc.)
When NOT To Use
- Editing code blocks, tables, or frontmatter (these have
- Quick scratch notes that will not be committed
These conventions apply to all markdown documentation generated or modified by any plugin. The goal: produce prose that creates clean, reviewable git diffs and reads well on mobile devices.
Quick Reference
When writing or editing markdown prose:
- Wrap prose at 80 chars using hybrid wrapping (prefer
- Blank line before and after every heading
- ATX headings only (
# Heading, never setext underlines) - Blank line before every list
- Reference-style links when inline links push lines
What to Wrap
Wrap these content types at 80 characters:
- Paragraphs (flowing prose text)
- Blockquote text (the content after
>) - List item descriptions (text after
-or1.) - Descriptions in definition lists
What NOT to Wrap
Never wrap or reflow these content types:
- Tables: pipe-delimited rows stay on one line
- Code blocks: fenced (
`) or indented content - Headings: lines starting with
# - Frontmatter: YAML/TOML between
---or+++ - HTML blocks: raw HTML elements
- Link definitions:
[id]: urlreference lines - Image references:
!alton their own line - Single-line list items: short bullets that fit on one line
Wrapping Algorithm (Summary)
For each prose paragraph:
- If a sentence fits within 80 chars, keep it on one line
- If a sentence exceeds 80 chars, break at the nearest
. ! ? ) before column 80
- If no sentence boundary, break at the nearest clause
, ; : ) before column 80
- If no clause boundary, break before a conjunction
and but or ) before column 80
- If none of the above, break at the last word boundary
- Never break inside backtick spans, link text, or URLs
See modules/wrapping-rules.md for the full algorithm with
examples.
Structural Rules
Blank Lines Around Headings
WRONG:
Some text.
Heading
More text.RIGHT:
Some text.
Heading
More text.
Exception: the first line of a file may be a heading without a preceding blank line.
ATX Headings Only
WRONG:
Heading
=======WRONG:
Subheading
----------
RIGHT:
# Heading
RIGHT:
Subheading
Blank Line Before Lists
WRONG:
Some introductory text:
- Item one
- Item two
RIGHT:
Some introductory text:
- Item one
- Item two
Reference-Style Links for Long URLs
When an inline link pushes a line beyond 80 characters, use reference-style syntax:
WRONG (line too long):
See the formatting guide for details.RIGHT:
See the [formatting guide][fmt-guide] for details.
[fmt-guide]: https://google.github.io/styleguide/docguide/style.html
Place link definitions at the end of the current section or at the end of the document. When the same URL appears multiple times, use a single shared reference definition.
Short inline links that keep the line under 80 chars are fine:
OK:
See the guide for details.
免费技能或插件可能存在安全风险,如需更匹配、更安全的方案,建议联系付费定制