用途:在编写或编辑任何会被提交的 Markdown 文档时,强制统一的换行与结构约定,目标是产出干净、便于评审的 git diff,并在移动设备上易读。不适用于编辑代码块、表格、frontmatter,也不适用于不会提交的临时草稿。
主要能力(换行规则):以 80 字符为界对正文做混合换行,优先在句子或从句边界断开,而非任意断词;需要换行的内容包括段落、引用文本、列表项描述、定义列表描述。不换行的内容包括表格、代码块、标题、frontmatter、HTML 块、链接定义、图片引用以及单行列表项。算法概要:句子能放进 80 字符则保留一行;超出则优先在最近的句子边界(. ! ?)前断开,其次从句边界(, ; :),再次连词(and but or),最后才是词边界;不得在反引号片段、链接文本或 URL 内部断开。
结构规则:每个标题前后要有空行(文件首行标题例外);只使用 ATX 标题(# 形式),不使用下划线式标题;每个列表前要有空行;当行内链接会使行超出 80 字符时,改用引用式链接,并把链接定义放在当前小节或文档末尾,同一 URL 重复出现时共用一条定义;能保持 80 字符内的短行内链接仍可接受。
退出标准:编辑文件中所有正文行的长度不超过 80 字符(可用 awk 'length>80' <file> 校验,排除表格、代码、标题、frontmatter);每个标题前后有空行,且无下划线式标题;每个列表前有空行;超长行内链接已转为引用式。
限制:完整换行算法与示例见 modules/wrapping-rules.md;除上述约定外,其他格式细节资料暂未提供。