SuperAPI AI 工具集

markdown

写作与研究

查看项目

更新于 10-16 04:05

技能介绍

用途

本技能用于规范 Markdown 文件的格式与结构,依据 CommonMark 规范、GitHub Flavored Markdown(GFM)扩展、Google Markdown 风格指南以及 markdownlint 默认规则,帮助在单个文件和整个项目中保持一致的写作风格。

主要能力

一致性选择

以下约定本身是任意的,但必须在文件内和项目内保持一致:

  • 标题:使用 ATX(#)形式,便于检索。
  • 无序列表:使用连字符(-),避免与强调符号 * 产生歧义。
  • 有序列表:使用惰性编号(全部写 1.),重排时 diff 更干净。
  • 强调:使用星号(斜体、粗体),比下划线更常见。
  • 代码围栏:使用反引号(```),而非波浪线。
  • 水平分隔线:使用 ---,仅三个连字符。
  • 链接风格:短链接或一次性链接用行内式,长链接或重复链接用引用式。

标题

  • 每个文件只有一个 #(H1),作为文档标题。
  • 层级每次只递增一级,不得从 ## 跳到 ####。
  • 每个标题前后各留一个空行。
  • 标题末尾不加标点(.、:、?)。
  • 标题内不使用强调(**、*、`)。
  • 标题文本在文档内必须唯一,以便可靠地生成片段链接。
  • 标题使用句子式大小写,仅首词和专有名词大写;H1 文档标题可例外使用标题式大小写。

列表

  • 无序列表统一使用 -;有序列表每项都写 1.。
  • 列表第一项之前和最后一项之后各留一个空行。
  • 紧凑列表(同一逻辑组)项之间不留空行;仅当某项包含多段落或多块内容时才在项之间留空行。
  • 单句项末尾不加句号;多句项所有句子都加句号。
  • 续行缩进与项文本首字符对齐(- 用 2 个空格,1. 用 3 个空格)。
  • 嵌套列表缩进与父项文本对齐,最多嵌套 3 层,更深说明内容应重构。

表格

  • 表格前后各留一个空行。
  • 使用首尾竖线:| cell | cell |。
  • 为便于源码阅读可垂直对齐竖线(规范不强制)。
  • 每行列数一致,不得参差不齐。
  • 表头分隔符使用 ---(每列至少三个连字符),竖线两侧留空格:| --- | --- |。
  • 单元格内容保持简洁;需要段落的内容不应放入表格。
  • 数据不是真正二维时优先用列表。
  • 展示标识符、命令或路径时在单元格内使用代码格式。
  • 不使用空表格;只有一列时改用列表。
  • 默认左对齐;数字可右对齐(分隔符用 ---:);对齐方式应少用。

代码块

  • 始终使用围栏代码块(三反引号),不使用缩进式代码块。
  • 开围栏后必须声明语言,如 rust、sql、```markdown。
  • 无语法高亮的纯输出使用 text 或 console。
  • 每个代码块前后各留一个空行。
  • Shell 示例:不显示命令与输出交错时,命令前不加 $;显示命令与输出时,仅命令行加 $ 前缀;语言标识用 sh 或 bash。
  • 示例保持最小化,只展示相关模式而非完整文件。
  • 注释少用,由周围文字解释示例。
  • 明确标注错误模式:// WRONG、// CORRECT、<!-- WRONG -->、<!-- CORRECT -->。

链接

  • 链接文本应脱离上下文也能理解,禁止使用“click here”“here”“this”“link”等。
  • 屏幕阅读器按链接文本导航,通用标签不可访问。
  • 链接文本保持简洁但有意义,通常 2-6 个词。
  • 短链接且只用一次用行内式 text;长链接或重复链接用引用式 [text][ref],并在文件或章节末尾集中定义 [ref]: url。
  • 外部链接使用 HTTPS。
  • 片段链接(#heading-text)必须指向文档中有效标题。
  • 同一仓库内链接使用相对路径。
  • 重命名或移动文件后需验证链接仍可解析。

空白字符

  • 任何行不得有行尾空白。
  • 不使用硬制表符,缩进用空格。
  • 文件以恰好一个换行结尾(EOF 处不留空行,也不缺换行)。
  • 不同类型块(标题、段落、列表、代码、表格)之间留一个空行。
  • 不得有多个连续空行,分隔符恰好一个空行。
  • 标题、代码块、表格、水平分隔线、列表前后各留一个空行。
  • 正文不设硬性行宽限制,由编辑器换行;代码块建议不超过 100 字符;表格行保持单行,宁可横向滚动也不换行。

反模式

常见错误及修正:

  • 混用列表标记(- 和 *):不一致、diff 混乱,应选定一种并全程使用。
  • 跳过标题层级:大纲层级断裂,应逐级递增。
  • 缩进式代码块:脆弱且无语言提示,应改用围栏代码块。
  • 裸 URL:可访问性差,应包成 描述性文本。
  • 强调符号带空格(* text *):不会渲染为强调,应去掉空格。
  • 通用链接文本(“click here”):不可访问、在链接列表中无意义,应描述目标。
  • 行内 HTML(<br>、<b>):破坏可移植性、难以维护,应使用 Markdown 等价写法。
  • 标题末尾标点:嘈杂且不一致,应去掉 .、:、?。
  • 多个 H1:文档标题不明确,应只在顶部保留一个 H1。
  • 代码围栏未声明语言:无语法高亮,应始终声明语言。
  • 多个连续空行:源码视觉噪音,应恰好一个空行。
  • 硬制表符:渲染不一致,应只用空格。

使用方式

资料未提供具体安装命令、调用方式或集成步骤,暂未提供。

适用场景

适用于需要统一 Markdown 写作风格的文档、README、技术说明、代码仓库文档等场景,尤其适合团队协作和需要保持 diff 整洁、链接可访问、结构清晰的项目。

限制

资料未提供关于平台、收费、价格、效果或具体工具集成的信息,暂未提供。