前言¶
技術文檔裏常見有序列表、分步說明和章節嵌套,讀者要在腦子裏串成一條線。手寫 Mermaid 能畫圖,但要先把 prose 拆成節點和邊,再選 flowchart、graph 等語法,維護成本不低。若希望 Agent 在對話里根據現有 Markdown 直接產出可渲染的流程圖,可以裝一個面向「文檔 → Mermaid」的 Skill,而不是每次從零寫圖。
下面介紹 SkillHub 上的 Markdown轉流程圖(座標 @user_6df795bb/markdown-to-flowchart,版本 1.0.0)。
這是什麼¶
Markdown轉流程圖 是社區來源(community)的 Agent Skill,發佈者爲 user_6df795bb,分類爲 dev-programming。它按通用 SKILL.md 規範編寫,供 Cursor、Claude Code、Codex 等支持 Skills 的客戶端加載。
Skill 的定位是:將任意 Markdown 文檔轉換爲 Mermaid 流程圖,用於可視化文檔中的步驟、流程、架構、依賴關係等。標籤 requires_api_key=false,不依賴額外 API Key。
核心功能¶
根據 SkillHub 頁面說明,已覈實的能力包括:
- 輸入:用戶提供的 Markdown 正文(或指向文檔內容的上下文),涵蓋部署、安裝、配置步驟,架構與 API 說明,README、教程、決策與任務流程、運維與故障排查等結構化文字。
- 輸出:Mermaid 流程圖代碼,便於在支持 Mermaid 的編輯器、文檔站或預覽器中渲染。
- 觸發意圖:當用戶說「做流程圖」「生成流程圖」「可視化文檔」「畫個圖」等類似需求時,Agent 應啓用該 Skill 的處理方式。
SkillHub 統計(頁面展示):評分 100000,下載 10327,安裝 137。
安裝與啓用¶
官方推薦兩種方式,本質都是按 SkillHub 安裝文檔拉取 @user_6df795bb/markdown-to-flowchart。
方式一:讓 Agent 按官方提示安裝¶
在對話中發送 SkillHub 給出的安裝提示(原文):
請根據 https://skillhub.cn/install/skillhub.md,安裝 `@user_6df795bb/markdown-to-flowchart`。
Agent 會讀取 SkillHub 安裝與優先源配置,檢查 skillhub CLI 並按規範安裝到當前環境的 Skills 目錄。
方式二:本機用 skillhub CLI¶
先確認 CLI 是否可用:
command -v skillhub && skillhub --version
未安裝時,可按安裝文檔執行完整安裝(示例爲文檔中的推薦命令):
curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash
安裝 Skill 時,必須用 --dir 指向當前 Agent 的 skills 目錄;裝到默認 ./skills/ 可能不會被客戶端識別。安裝文檔給出的常用路徑示例:
| 客戶端 | Skills 目錄(示例) |
|---|---|
| Cursor | ~/.cursor/skills/ |
| Claude Code | ~/.claude/skills/ |
| Codex | ~/.codex/skills/ 或項目下 .agents/skills/ |
在對應目錄下安裝本 Skill 的命令形式爲(與安裝文檔第三節一致,將技能名換爲本座標):
skillhub install user_6df795bb/markdown-to-flowchart --dir ~/.cursor/skills/
將 ~/.cursor/skills/ 換成你實際使用的 Agent 路徑。安裝後按各客戶端要求刷新或重啓,使 Skill 生效。
典型用法¶
公開資料未附帶固定 CLI 子命令;用法以「對話 + Skill 指令」爲主,可復現的流程如下。
- 確認已安裝
@user_6df795bb/markdown-to-flowchart且 Agent 已加載 Skills。 - 粘貼或引用需要可視化的 Markdown(例如 README 中的安裝步驟、故障排查清單)。
- 用 Skill 說明中的意圖觸發,例如:「把下面這段 Markdown 生成 Mermaid 流程圖」或「可視化這份部署文檔」。
- 在回覆中拿到 Mermaid 源碼,粘貼到支持 Mermaid 的預覽環境覈對節點與連線是否符合原文順序與分支。
輸出爲 Mermaid 文本,具體圖表類型(流程圖、時序等)由 Skill 內指導 Agent 根據文檔結構選擇;若需固定版式,可在提問時補充約束(如「只保留主路徑,省略異常分支」)。
適用場景與注意¶
適合誰:寫技術文檔、運維手冊、架構說明的開發者;希望在評審或交接時用一張圖概括步驟,又不想長期手寫 Mermaid 維護的團隊。
適用內容:步驟鏈、分支判斷、依賴關係、模塊協作等能從 Markdown 結構推斷出「先後」與「分支」的文本。官方列舉的場景包括技術文檔、系統架構、API 文檔、README、教程、決策與任務流程、項目管理、運維與故障排查等。
注意:
- 複雜 prose 或表格密集段落,自動構圖可能漏節點或合併過度,生成後應人工對照原文校對。
- Mermaid 需在目標平臺開啓支持;不同渲染器對語法子集支持略有差異。
- 版本以 SkillHub 爲準,當前爲 1.0.0;升級可通過
skillhub與安裝文檔中的更新流程處理。
結尾¶
Markdown轉流程圖 把「文檔已有、圖還沒有」的缺口補上:在對話裏用自然語言要圖,由 Agent 按 Skill 把 Markdown 轉成 Mermaid 流程圖,且無需 API Key。安裝與詳情見 SkillHub 官方頁:
- 頁面:https://www.skillhub.cn/skills/user_6df795bb/markdown-to-flowchart
- API 條目:https://api.skillhub.cn/user_6df795bb/markdown-to-flowchart