Skill/设计创作/Markdown Mermaid Writing
设计创作 55.5k 仓库 Star

Markdown Mermaid Writing

用可编辑的文本讲清复杂关系

这是一套用 Markdown 文档和 Mermaid 图形语法组织技术说明的流程。它把步骤、时序与关系写成可编辑文本,便于持续维护、对比版本和交接,并提供图形选择、文档模板与渲染检查指导。完成后保留源码与验证记录,方便团队协作和后续改动。

你需要准备:流程步骤、角色关系或系统交互,以及需要解释给谁看

一桉AI 整理 · 2026.10.31 更新 · 查看 GitHub 来源

粘贴到 Codex,它会先检查安装条件,再引导你使用。

Markdown Mermaid Writing 能帮你做什么?

  • 选择合适的结构图

    依据要解释的是流程、时间、层级还是关系,选择相应图形与参考写法。

  • 编写可维护文档

    将说明、图形源码和必要标签放在一起,便于后续修改与项目交接。

  • 检查版本与展示

    使用目标环境支持的语法,按需本地渲染,核对布局、文字和可读性。

什么时候适合用?

下面是用法示例,可换成你的材料和目标。

  • 说明一个订单流程

    示例场景:把参与方、关键步骤和异常分支整理成可编辑流程图,和业务说明一起保存。

  • 记录接口交互顺序

    示例场景:用时序图表达请求与返回,保留源文档,使接口调整时可以同步修改。

怎么开始使用?

从材料到结果流程示意,非实测结果

流程、关系或交互说明

准备这些材料文本流程图与文档

流程步骤、角色关系或系统交互,以及需要解释给谁看

文本图解制作流程

  1. 01

    梳理节点与真实关系

  2. 02

    编写文档和图源码

  3. 03

    检查语法并预览

准备什么,会得到什么?

准备的材料
流程步骤、角色关系或系统交互,以及需要解释给谁看
交付的结果
  • Markdown 文档与 Mermaid 图形源码。
  • 按需渲染的图片及实际验证说明。

使用前要知道

精确数值图应使用绘图库。仅写文档无需运行时,本地导图需 Node.js、Mermaid CLI 与 Chromium;源 Skill 为 Apache-2.0,本站未实测。

常见问题

普通 Markdown 编辑器都能显示图吗?

只有支持相应 Mermaid 语法的环境能直接显示;否则需要兼容渲染工具或导出为图片。

为什么不直接交付一张图片?

保留文字源码能继续修改流程和关系,也更方便查看版本差异;需要固定展示时仍可另导图片。

GitHub 与官方参考

依据项目说明与参考文档整理。页面中的任务与流程示例用于说明用法。

  • Markdown Mermaid Writing · Skill 源文件 ↗2026-10-31 核对
来源与使用条件
原始项目
K-Dense-AI/scientific-agent-skills ↗
Skill 名称
markdown-mermaid-writing
Skill 目录
skills/markdown-mermaid-writing
仓库 Star
55,487 · 2026-10-31 核对,仅代表仓库关注度。
许可说明
Apache-2.0
使用条件
仅编写 Markdown 和 Mermaid 源码不需要额外运行时。本地渲染 SVG/PNG 需要 Node.js 22.13+、Mermaid CLI 与 Chromium;保留所需模板和参考资源。
注意事项
上游明确支持 Codex。适合流程、结构和交互图;精确数值图应使用绘图库。需要渲染时应检查语法与图形布局,本站未运行实测。
查看安装与使用提示词
请帮我准备并使用 Markdown Mermaid Writing Skill,完成下面的任务。请实际执行当前环境允许的安装与检查,不要只返回一份安装教程。

【来源与目标】
原始仓库:https://github.com/K-Dense-AI/scientific-agent-skills
所选目录:skills/markdown-mermaid-writing
参考分支:main
原始目录 frontmatter name:markdown-mermaid-writing
安装后的目标调用名:markdown-mermaid-writing
来源页面:https://github.com/K-Dense-AI/scientific-agent-skills/tree/main/skills/markdown-mermaid-writing
安装路线核对日期:2026-11-01
当前 SKILL.md(已重新核对名称与资源引用):https://github.com/K-Dense-AI/scientific-agent-skills/blob/main/skills/markdown-mermaid-writing/SKILL.md
上游安装说明:https://github.com/K-Dense-AI/scientific-agent-skills/blob/main/README.md
Codex 官方 Skill 目录与自动发现规则:https://learn.chatgpt.com/docs/build-skills

【先检查环境,再安装】
先识别操作系统、当前 shell、工作目录、同名 Skill 和已有工具;命令须适配实际平台并正确处理带空格的路径。默认安装到当前项目的 .agents/skills;如果没有可用项目目录,再使用用户目录的 .agents/skills。遵循当前 Codex 实际支持的位置;上游 CLI 或插件有专用目录时使用其正式方案。检查现有安装来源与完整性,能复用就复用,不重复注册相同来源、不覆盖用户修改。系统内置与所选第三方来源同名时保留系统版,明确区分来源和实际目录,不能只凭名称认定装过或选对了。
下文 ~/.agents/skills 是用户级路径示例;已选项目范围时,使用项目的 .agents/skills 并保持相同子目录层级。<SKILL_DIR>、<项目根目录> 等占位符须先换成核对过的真实路径再执行。依赖仓库的存放目录与 Codex 发现入口分别处理,不把缓存目录当作已注册入口。
这是完整目录安装路线。优先使用当前 Codex 自带的 $skill-installer,明确传入仓库 K-Dense-AI/scientific-agent-skills、目录 skills/markdown-mermaid-writing、分支 main、安装名 markdown-mermaid-writing,并把 --dest 设为已解析的目标 .agents/skills 绝对路径。目录为“.”时表示仓库根目录,仍要传入安装名。不要猜测安装器在本机的固定路径。如果没有内置安装器,按下列项目说明从原仓库获取完整目录,保留全部配套文件。

所选 Skill 的具体安装步骤:
1. 先解析当前项目根目录,以该项目的 .agents/skills 为本次目标;查找已有 markdown-mermaid-writing,已有本地修改时保留,避免覆盖或在用户目录重复安装。
2. 使用 Codex 自带 skill-installer 的 install-skill-from-github.py;参数明确为 --repo K-Dense-AI/scientific-agent-skills --path skills/markdown-mermaid-writing --ref main --name markdown-mermaid-writing --dest <project>/.agents/skills;<project> 要先解析为当前项目绝对路径。完整保留所选目录,不只下载 SKILL.md。
3. 基础使用仅复制完整目录。只有用户需要 SVG/PNG 导出或当前宿主无法显示 Mermaid 时,再按 references/current-rendering.md 准备兼容渲染器;源文件当前本地目标为 Mermaid/CLI 12.0.0、Node.js 22.13+ 与支持的 Chromium,不盲装整仓 Python 工具。
4. 确认目标目录 markdown-mermaid-writing/SKILL.md 的 frontmatter name 为 markdown-mermaid-writing,并按 resources 保留引用资源和许可文件。
5. Codex 会自动发现项目 .agents/skills;在当前项目查看 Skill 列表。只有未出现时才新建聊天或重载,不把强制重启写成每次安装步骤。

必须保留的资源:
- skills/markdown-mermaid-writing/SKILL.md
- skills/markdown-mermaid-writing/assets
- skills/markdown-mermaid-writing/references
- skills/markdown-mermaid-writing/templates
- 引用内容的 Apache-2.0 署名与许可头,以及仓库主许可记录

已知依赖:仅编写 Markdown 和 Mermaid 源码不需要额外运行时。本地渲染 SVG/PNG 需要 Node.js 22.13+、Mermaid CLI 与 Chromium;保留所需模板和参考资源。
原项目许可:Apache-2.0
特别条件:上游明确支持 Codex。适合流程、结构和交互图;精确数值图应使用绘图库。需要渲染时应检查语法与图形布局,本站未运行实测。
需要账号、密钥或服务时先检查现有可用连接;让用户在官方授权或本地配置入口完成,不要求把密钥粘贴到聊天。缺少付费服务或不支持的客户端能力时,明确剩余条件与可完成的范围。

【安装后验收】
读取实际安装位置的 SKILL.md,核对真实 name,并检查它引用的脚本、模板、共享文件与工具是否存在。若上游已迁移路径或更名,先核对正式说明再调整;找不到则报告实际错误,不猜路径或宣称成功。
1. 只读检查 references/diagrams、references/current-rendering.md、templates 与 assets/examples 都存在;纯 Markdown 编写不需要安装 Node 或 Mermaid CLI。
2. 只读检查已安装 SKILL.md 的 name、所列引用文件与目录存在,元数据调用名使用 markdown-mermaid-writing。
Codex 通常自动发现变更;只有未出现时才引导新建聊天或重载。若本轮尚未出现在可用列表,可在允许的范围内读取已安装的完整文件继续准备任务,同时说明自动识别尚待确认。插件依赖的工具未连接时,不能用读取文件代替连接成功。
分别报告“文件已安装”“Codex 已识别”“任务所需能力已就绪”的实际状态和证据;失败时给出卡住的步骤、错误与下一步,不反复执行相同的失败命令。

【接着引导我使用】
请使用实际可用的 $markdown-mermaid-writing;若实际名称发生变化,以刚核对的本地 name 为准。存在不同来源同名项时,明确选择所选来源与实际文件路径,避免调用成系统版或另一版本。对于必须由用户显式调用的 Skill,直接给我下一条可复制的调用语句。
- 先确定目标文档和实际展示平台,读取相应模板、Markdown 规范和图型参考;结构/关系用 Mermaid,保留可编辑 .md 源码。
- 在实际目标平台检查支持的 Mermaid 版本;不能用本地新版本成功来保证 GitHub 渲染。定量研究图继续用合适绘图工具,不强制先画 Mermaid。

我想完成的任务:
把我提供的流程或系统关系整理成结构清楚的 Markdown 文档,并选择合适的 Mermaid 图。保留真实角色、条件和先后关系,对不确定处作标记;检查图的语法和文字可读性,交付可编辑源码,有可用渲染环境时再附预览。

需要我提供的材料:
流程步骤、角色关系或系统交互,以及需要解释给谁看

期望得到:
Markdown 文档和 Mermaid 图源码;具备渲染环境时附 SVG 或 PNG 预览。

先查看我在当前聊天中已经提供的目标与材料,只问缺少的关键内容;没有材料时,告诉我第一步提供什么,可给一个简短示例。条件满足后从一个小任务开始,检查输出,再说明怎样继续使用。示例仅用于演示,不充当我的真实数据;没有执行过的步骤、测试或交付物不要写成已经完成。需要发送、发布或修改外部账号内容时,先让我核对具体对象和内容。

相关 Skill

  • UI UX Pro MaxUI 设计系统
  • Claude Design System本地设计系统
  • Theme Factory统一配色与字体

复制到 Codex

浏览器暂未允许直接复制。点击下方文字,按 Ctrl+C(Mac 按 ⌘C)复制,再粘贴到 Codex。

三步开始使用

  1. 找到想做的事,点击「复制提示词」。
  2. 打开 Codex,把提示词粘贴进去并发送。
  3. 按它的提示提供文件或材料,继续完成任务。

按需安装就好,不用一次装完。部分 Skill 需要软件、账号或付费服务,Codex 会先检查使用条件。