Nm Leyline Markdown Formatting

强制Markdown换行与结构规则,确保代码差异清晰可读。

已扫描
适合谁
技术文档撰写者、开源项目维护者
不适合谁
仅需快速草稿的用户、不使用Git版本控制的场景
国内可用性
需网络配置。可能需要网络配置或第三方服务可访问。
安装难度
新手友好(★☆☆)。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @athola/nm-leyline-markdown-formatting

Skill 说明

命令、参数、文件名以原文为准

夜市技能 — 由 [claude-night-market/leyline](https://github.com/athola/claude-night-market/tree/master/plugins/leyline) 移植而来。如需完整体验(包括代理、钩子和命令),请安装 Claude Code 插件。

Markdown 格式化规范

何时使用

  • 编写或编辑任何 Markdown 文档
  • 审查文本是否符合换行规范
  • 从插件生成 Markdown(如 scribe、sanctum 等)

何时不使用

  • 编辑代码块、表格或 frontmatter(这些有独立的格式规则)
  • 仅用于快速草稿且不会提交的内容

本规范适用于所有由插件生成或修改的 Markdown 文档。目标是生成清晰、可审查的 Git 差异,并在移动设备上阅读体验良好。

快速参考

编写或编辑 Markdown 正文时:

  1. 正文在 80 字符处换行,采用混合换行方式(优先选择句子或分句边界,而非任意断词)
  2. 每个标题前后均留空行
  3. 仅使用 ATX 标题格式# 标题,禁止使用 setext 下划线形式)
  4. 每个列表前留空行
  5. 长链接使用引用样式,当内联链接使行超出 80 字符时

需要换行的内容类型

在 80 字符处换行的内容包括:

  • 段落(流动的正文文本)
  • 引用块内容(> 后的内容)
  • 列表项描述(- 1. 后的文本)
  • 定义列表中的描述

不应换行的内容类型

以下内容类型永远不应换行或重新排版

  • 表格:管道分隔的行保持在一行
  • 代码块: fenced(```)或缩进内容
  • 标题:以 # 开头的行
  • frontmatter:位于 ---+++ 之间的 YAML/TOML 内容
  • HTML 块:原始 HTML 元素
  • 链接定义[id]: url 的引用行
  • 图片引用:单独一行的 ![alt](url)
  • 单行列表项:一行即可容纳的短条目

换行算法(概要)

对每段正文执行以下步骤:

  1. 如果句子在 80 字符内,保持单行
  2. 若句子超过 80 字符,在列 80 之前最近的 句子边界. ! ? )处断开
  3. 若无句子边界,在列 80 之前最近的 分句边界, ; : )处断开
  4. 若无分句边界,在列 80 之前最近的 连接词and but or )处断开
  5. 若以上均无,则在列 80 之前的最后一个 单词边界 处断开
  6. 绝不在反引号片段、链接文本或 URL 内部断行

详见 modules/wrapping-rules.md 获取完整算法及示例。

结构规则

标题周围的空行

错误:
一些文字。
## 标题
更多文字。

正确:
一些文字。

## 标题

更多文字。

例外:文件首行可为标题,无需前置空行。

仅使用 ATX 标题

错误:
标题
=======

错误:
子标题
----------

正确:
# 标题

正确:
## 子标题

列表前留空行

错误:
一些介绍性文字:
- 项目一
- 项目二

正确:
一些介绍性文字:

- 项目一
- 项目二

长 URL 使用引用样式链接

当内联链接使行超出 80 字符时,使用引用样式语法:

错误(行过长):
参见 [格式指南](https://google.github.io/styleguide/docguide/style.html) 了解详情。

正确:
参见 [格式指南][fmt-guide] 了解详情。

[fmt-guide]: https://google.github.io/styleguide/docguide/style.html

将链接定义放置在当前章节末尾或文档末尾。若同一 URL 多次出现,使用单一共享的引用定义。

短内联链接若保持在 80 字符以内,可直接使用:

正确:
参见 [指南](https://example.com) 了解详情。
A
@athola

已收录 2 个 Skill

相关推荐