@yieldcraft/doc-viewer
在Pi-web中浏览和渲染工作区文档与Markdown文件,支持Mermaid图表。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:@yieldcraft/doc-viewer。 它的用途是:在Pi-web中浏览和渲染工作区文档与Markdown文件,支持Mermaid图表。 完整的 Skill 内容见:https://321skill.com/skills/yieldcraft-doc-viewer/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“请用Doc-Viewer打开工作区根目录下的‘项目规划.md’文件。”,它会安全读取该文件,并将其内容以清晰的格式展示出来,特别是将文档中用Mermaid语法定义的流程图自动渲染成可视化的图形,方便你直接审阅和讨论。
介绍
Doc-Viewer是一个专为Pi-web设计的插件,它解决了用户在AI工作空间中无法便捷查看和格式化展示本地文档(特别是Markdown文件)的痛点。通过调用稳定的文件API,它能够安全地读取工作区内的文档,并以清晰、美观的格式进行渲染,尤其支持将Mermaid语法代码块渲染为可视化图表,极大提升了文档的可读性和协作效率。
使用方式非常简单直接。用户只需在Pi-web环境中安装并启用此插件,即可在工作区界面中直接打开并浏览Markdown(.md)等文档文件。插件会自动识别文档中的标题、列表、代码块等标准Markdown语法,并进行格式化展示。当文档中包含Mermaid图表定义时,插件会将其自动转换为直观的流程图、序列图等图形,无需用户进行额外操作。
这个插件非常适合所有在Pi-web环境中进行文档编写、技术分享、项目规划或知识管理的用户。无论是开发者需要查阅项目README、技术文档,还是产品经理、项目经理需要编写和审阅包含流程图的方案文档,都能从中受益。它让文档的撰写、审阅和分享过程更加流畅。
建议用户确保工作区内的文档路径和文件权限设置正确,以便插件能够顺利读取。由于它依赖于Pi-web平台和特定的文件API,主要适用于在该平台内部进行文档协作的场景。对于需要复杂编辑或版本控制等高级功能的用户,可能需要结合其他专业工具使用。
核心特点
核心区别在于其深度集成于Pi-web工作空间,直接利用平台稳定的文件API安全读取和渲染文档,而非通用的网页Markdown解析器;同时,它原生且稳定地支持Mermaid图表渲染,解决了在AI工作环境中可视化呈现技术架构和流程的刚需。
注意事项
该Skill主要依赖Pi-web环境及其文件API,不适合在Pi-web平台之外或需要离线、复杂编辑功能的场景下使用。
常见问题
Doc-Viewer支持哪些文件格式?
主要支持Markdown (.md) 文件,并能渲染其中的Mermaid图表。
它需要联网才能渲染Mermaid图表吗?
不需要,Mermaid图表的渲染在本地完成,不依赖外部网络。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/yieldcraft-doc-viewer/raw/index.md 读取 @yieldcraft/doc-viewer 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/yieldcraft-doc-viewer/raw/index.md(查看排版版本)