SuperAPI AI 工具集

markdown-formatter

写作与研究

查看项目

更新于 10-16 05:38

技能介绍

用途

Markdown Formatter 是一个用于格式化、校验和优化 Markdown 文档的技能,目标是创建风格一致、可读性强、呈现专业的 Markdown 文档,帮助维护高质量的文档标准。

主要能力

  • 格式化:统一标题、列表、链接等元素的样式。
  • 校验:检查语法错误和问题。
  • 目录生成:自动生成目录(TOC)。
  • 风格检查(Linting):执行风格规则和最佳实践。
  • 转换:在 HTML、PDF 及其他格式之间转换。
  • 模板:提供可直接使用的文档模板。
  • 批量处理:一次格式化多个文件。
  • 自定义规则:定义项目专属的格式化规则。

使用方式

使用该技能时,按以下步骤操作:

  1. 提供内容:分享原始 Markdown 或文件路径。
  2. 指定风格:选择格式化风格或指南。
  3. 设置选项:配置目录、链接、代码格式化等。
  4. 格式化:应用一致的格式。
  5. 校验:检查错误和问题。
  6. 审查:确认输出符合要求。
  7. 部署:在项目中使用格式化后的 Markdown。

适用场景

  • 跨项目统一 Markdown 格式。
  • 清理和改进文档。
  • 发布前校验 Markdown 语法。
  • 自动生成目录。
  • 创建专业的 README 文件。
  • 统一代码示例格式。
  • 对文档应用风格指南。
  • 在 Markdown 方言之间转换。

格式化规则与风格指南

标题层级:H1 用于文档标题,H2 用于主要章节,H3 用于子章节,H4 用于更细分的子章节。

列表:支持无序列表(含嵌套项)和有序列表。

代码块:使用带语言标识的围栏代码块,例如 python、bash 等。

链接与图片:支持行内链接、引用式链接、行内图片和引用式图片。

表格:使用标准 Markdown 表格语法。

风格指南涵盖:标题大小写一致性、正文使用句子式大小写、仅缩写或强调时使用全大写;章节之间保留一个空行、代码块前后保留空行、缩进一致(2 或 4 个空格);强调语法包括斜体、粗体、粗斜体、删除线和行内代码。

常见问题修复

  • 标题层级不一致:规范为正确的层级结构。
  • 链接失效:更新或移除失效链接。
  • 缺少空行:补充适当间距。
  • 表格未对齐:重新格式化以提升可读性。
  • 代码块语言标签不一致:添加或修正语言标识。
  • 链接杂乱:使用引用式链接进行组织。
  • 缺少替代文本:为图片添加有意义的 alt 文本。

校验检查

格式化工具会校验:标题层级是否正确、链接格式是否有效、括号和圆括号是否配对、代码块围栏是否正确、表格结构与对齐、图片路径有效性、重复的标题 ID。

输出格式

该技能可导出为:Markdown(.md,标准格式)、HTML(.html,适合网页)、PDF(.pdf,适合打印)、HTML Slides(演示格式)、EPUB(.epub,电子书格式)。

支持的 Markdown 方言

CommonMark(标准)、GitHub Flavored Markdown(GFM)、MultiMarkdown、Pandoc Markdown、自定义方言。

最佳实践

  • 使用描述性标题,让文档结构清晰。
  • 积极使用链接,连接相关章节和外部资源。
  • 正确格式化代码,始终使用带语言标签的代码块。
  • 有目的地添加图片,说明复杂概念。
  • 用表格呈现数据,让对比更清晰。
  • 为快速浏览而写作,许多用户只是略读而非细读。
  • 保持 DRY,避免重复信息。

限制

资料中未提供关于收费、价格、平台支持范围、具体性能指标或效果保证的信息。