mcpField
F
format-markdown

format-markdown

github.com/arthurzakirov文档处理0170 次安装3 天前更新
代码仓库

关于 format-markdown

用于创建或修改 Markdown 文档的 Skill,确保内容有效、易读且忠实于原意。面向作者和 Agent,也针对机器读取的文件及易变的引用数据提供指导。

主要功能

  1. 01保留原意与示例
  2. 02修正语法和 Markdown 格式
  3. 03维护有效的 YAML 与代码围栏
  4. 04为可解析的文件引用添加链接
  5. 05兼顾机器读取与人工阅读

适用场景

  1. 01编辑 README 或 Markdown 指南
  2. 02将笔记或转录整理成文档
  3. 03维护 AGENTS.md 或 SKILL.md 文件
  4. 04修改包含路径和版本信息的 Markdown

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/arthurzakirov/systemsmith --skill format-markdown

安装后在 Claude Code 中输入/format-markdown确认已加载。

详细介绍

Markdown 格式化器

用户请求:$ARGUMENTS

对于表格与列表、层级、散文、图示及其他表达形式的选择,请应用 information-representation-design。对于信息选择、抽象分层、路由和渐进式披露,请应用 relevance-first-information-design。如果源内容是原始笔记、口述内容、转录稿或头脑风暴记录,且需要还原其概念结构,而非按源顺序照搬,请应用 thoughts-to-artifact。

如果输出包含当前状态值、快照、文件树、版本、路径或其他可能随时间变化的数据,也请应用 living-artifacts。

核心任务

创建或编辑 Markdown 文档,使其保持有效、易读、便于导航,并忠实表达预期含义。对于 AGENTS.md 和 SKILL.md 等供机器处理的 Markdown,应将其视为面向双重受众的文档:既要便于 Agent 正确使用,也不能牺牲人工审阅和导航体验。

保留规则

  • 保留所有已有的关键信息、细微差别和示例。
  • 在不改变含义的前提下,修正明显的拼写、语法、转录噪声、病句和 Markdown 语法错误。
  • 不要编造缺失的内容。
  • 仅在不改变含义且能提升清晰度时调整内容顺序。
  • 如果需要保留额外指导,但不应将其作为文档内容,请在适当时使用 HTML 注释。

Markdown 专项规则

  • 如果 $ 语法在语义上属于源内容,请按原样保留。
  • 如果目标文档需要 YAML/frontmatter,请确保其有效。
  • 使用有效的标题层级;不要仅为改变视觉大小而跳过层级。
  • 在适当情况下,将仓库、文件夹、文件、命令、函数、变量、配置键和其他字面技术标识符设为行内代码。
  • 在维护中的 Markdown 文档中,如果存在实际目标,请为具体文件引用添加可点击的正确相对链接。
  • 确保代码围栏语法有效,并在已知时保留预期的语言标识符。
  • 如果字面字符可能被误解析,请转义或调整 Markdown 结构。

自检

  • 含义得到保留。
  • 未编造事实。
  • Markdown 按预期解析。
  • Frontmatter 和代码围栏保持有效。
  • 每个具有可解析目标的文件或路径引用都应成为有意义的可点击 Markdown 链接;对于无法解析的目标,应明确指出,而不是伪装成链接。
  • 供机器处理的 Markdown 仍便于人工审阅和检查。
  • 表达形式选择以及相关性/披露规则应由专门的技能提供,而不是在此重新定义。
  • 转换原始想法时,应根据 thoughts-to-artifact 保留示例和细微差别。

评论

支持 Markdown