SuperAPI AI 工具集

markdown-mermaid-writing

写作与研究

查看项目

更新于 10-15 23:43

技能介绍

用途:为科学类 Markdown 文档(报告、README、方法概述、研究笔记)配 Mermaid 结构图,也用于维护可编辑的 Mermaid 源码及其导出的 SVG/PNG。它不替代科学分析或定量绘图。

主要能力:提供 Markdown 与 Mermaid 两套风格指南、23 类图表指南(flowchart、sequence、ER、state、gantt、C4、mindmap、timeline、class、user journey、quadrant、requirement、sankey、xy chart、block、kanban、architecture、radar、treemap、packet、git graph、zenuml、pie)及组合示例,另有 9 类文档模板(decision_record、how_to_guide、issue、kanban、presentation、project_documentation、pull_request、research_paper、status_report)与示例报告。

使用方式:先判断文档类型并选模板,再读 references/markdown_style_guide.md;制图前读 references/mermaid_style_guide.md,并打开对应类型文件(如 references/diagrams/flowchart.md)取模板与示例。规则包括:全文仅一个 H1;emoji 只用于 H2;表格优于长段落;在支持的类型上加 accTitle、accDescr;优先宿主主题与 classDef。radar 需用 radar-beta,用 axis 定义维度、curve 定义数据,而非 x-axis 与带冒号标签;xy chart 用 xychart-beta 与 x-axis。

限制:仅在支持 Mermaid 的宿主渲染,纯 Markdown 查看器可能只显示代码,各平台与扩展的 Mermaid 版本不同;导出 SVG/PNG 需渲染器,且应保留图表源码。交付前需在目标环境实际渲染,并核对版本与插件要求。不支持 accTitle/accDescr 的类型,需在其上方加描述性斜体段落。许可证与归属:样式指南、图表指南与模板移植自 SuperiorByteWorks-LLC/agent-project(Apache-2.0,作者 Clayton Young / Superior Byte Works, LLC);本技能随 scientific-agent-skills 以 MIT 分发。