markdown-viewer/skills

Opinionated skills for AI coding agents to create stunning diagrams and visualizations directly in Markdown. These skills extend agent capabilities across diagram generation, data visualization, and technical documentation.

解决的问题

此项目为 AI 代理(如 Claude Code、Cursor 和 GitHub Copilot)提供了一组“技能”,帮助它们直接在 Markdown 中生成高质量、专业的视觉内容,例如架构图、图表和信息图表。它弥补了代理编写文字的能力与使用特定渲染引擎创建结构化视觉文件能力之间的差距。

运作方式

该项目组织为一个遵循 Agent Skills 格式的技能包 (documd-visuals)。它作为一个路由器,引导 AI 代理完成 31 个不同的目标领域(例如软件设计、云端架构、商业报告)和 183 个场景。

当代理收到请求时,它会使用 SKILL.md 路由器将用户的意图与特定的目标领域进行匹配,然后根据场景选择适当的渲染引擎:

  • PlantUML/puml:用于 UML、ArchiMate、BPMN 以及网络/安全架构。
  • Vega/Vega-Lite:用于具有统计转换的数据驱动图表。
  • ECharts:用于报告级仪表板和仪表。
  • Infographic:用于模板驱动的路线图和比较。
  • HTML/CSS:用于系统架构图和页面布局。

此外还提供了一个可选的 documd CLI 工具,用于将这些基于 Markdown 的视觉内容导出为 PDF、DOCX 或 SVG 等成品文件。

目标受众

  • AI 代理用户:使用编码代理来生成技术文件的用户。
  • 技术作家:希望将视觉内容作为 Markdown 中的文字进行维护,以便于版本控制的人员。
  • 开发人员:需要通过 AI 快速生成复杂系统图和架构图的工程师。

特色亮点

  • 丰富的库:包含跨越 31 个目标领域的 242 个验证示例。
  • 代理就绪:专为通过 npx skills add 与 AI 编码代理集成而设计。
  • 多引擎支持:集成了五种不同的渲染引擎,涵盖从 UML 到信息图表的所有内容。
  • 主题样式:支持九种不同的主题,以确保视觉的一致性和对比度。
  • 导出功能:提供 CLI,用于将 Markdown 视觉内容转换为专业文档格式。

相关

  • 项目
  • 项目
  • 项目
  • 项目
  • 项目