Markdown 规范写作
把技术笔记、README 或说明文档按 Markdown 写作规范新建或改写,处理好标题层级、空行、Callout、链接和公式。
功能与用途
自己写的 Markdown 在 Obsidian 里能看,扔到 GitHub 上 Callout 变成普通引用块、链接全成了死文字。它按一套成文规范处理标题、行内代码、空行、Callout 和链接写法,并区分 Obsidian 仓库与 GitHub 文档两种环境各用哪种写法。开工前先确认文档放哪种环境,有模板的文档类型(如菜谱、日志)按模板走,不强套规范。
适用场景
- 知识库里的笔记在 Obsidian 用 [[]] 互链没问题:知识库里的笔记在 Obsidian 用 [[]] 互链没问题,但 README 推到 GitHub 后这些链接全变成了纯文本
- 接手一份别人写的技术文档,标题层级乱、代码块前后空行随意,需:接手一份别人写的技术文档,标题层级乱、代码块前后空行随意,需要按统一规范整一遍
- 要把一篇讲网络协议的手写笔记整理成规范文档,术语标题和状态码:要把一篇讲网络协议的手写笔记整理成规范文档,术语标题和状态码不知道怎么标注才统一
适用人群
- Obsidian 知识库用户
- 技术文档维护者
- 开源项目 README 作者
使用步骤
- 先说明这份文档在 Obsidian 仓库还是 GitHub,决定链接和 Callout 写法
- 把要新建或要整理的 Markdown 内容给出来
- 拿到规范化后的文档,重点看标题层级、空行、行内代码和 Callout 是否合规
- 按完成后的六项自查逐条核对,有问题再指出来改
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 知识
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 简单
- 版本
- main
- 最近更新
- 2026-09-14
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
按《Markdown 写作规范》新建或规范化 Markdown 文档(技术/知识笔记、README、说明文档)。当用户说「按规范整理这篇」「规范化文档」「format 这篇 md」「帮我写一篇符合规范的文档」时使用。开始前先确认目标是 Obsidian 仓库还是 GitHub 文档。菜谱、日志等有强结构模板的文档按其模板组织,不强套本规范。
使用前准备
- 说明文档运行环境是 Obsidian 仓库还是 GitHub 文档
- 无命令或依赖门槛
依赖与权限
- 读取用户主动提供的内容