mcpField
A
andocs

andocs

github.com/blogic-cz开发340 次安装2 天前更新
代码仓库

关于 andocs

一项指导 Agent 编写和编辑 Andocs 文档与原型的技能。它按任务指向相关参考资料,并提供本地预览和文件检查步骤。

主要功能

  1. 01按任务选择参考资料
  2. 02创建介绍和本地演示
  3. 03编辑文档与原型
  4. 04检查本地预览前提
  5. 05验证引用文件和代码块

适用场景

  1. 01编写 Andocs 介绍
  2. 02编辑原型或页面导航
  3. 03准备本地文档预览
  4. 04检查原型状态处理

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/blogic-cz/blogic-marketplace --skill andocs

安装后在 Claude Code 中输入/andocs确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
introduction.md
markdown.md
opendesign.md
prototype-releases.md
prototype-state-legacy.md
prototype-state.md
prototypes.md
web-components.md

详细介绍

Andocs 编写

如需介绍 Andocs 或进行本地演示,请遵循介绍流程。使用该指南中发布的 CLI 命令启动本地预览。

对于其他编辑任务,请在编辑前根据请求或仓库确定文档根目录。如果仍有多个可能的根目录,请询问应使用哪一个。遵循仓库的语言和预览规则。

阅读与工作相匹配的参考资料:

  • Markdown 渲染 — 编写图表、数学公式、交互式 html-preview 代码块或 Andocs 专用链接时阅读。
  • 原型 — 创建或编辑 prototype.json、HTML 页面、页面间导航、相对静态文件、共享资源或 prototype 代码块时阅读。
  • 审核状态与发布版本 — 原型使用屏幕审核徽标、releases.json 或 <id>@<release>.html 屏幕变体时阅读。
  • 原型状态 — 原型数据需要在刷新后保留,或现有有状态原型需要迁移时阅读。
  • Web Components — 原型使用 Custom Elements 或 Shadow DOM 时阅读。
  • OpenDesign 交接 — 用户要求在 OpenDesign 中编辑 Andocs 原型,或要求根据源文件准备 OpenDesign 时阅读。

如需本地预览,请确定文档根目录并检查 Bun 是否可用。只有在用户和仓库说明均授权启动服务时,才使用 bunx andocs@latest serve --path <docs-root>。CLI 帮助命令为 bunx andocs@latest -h。

完成前,请检查所引用的文件是否存在、围栏代码块是否使用正确的语言,以及任何原型状态是否能处理存储不可用的情况。公开的 Andocs 演示展示了完整的原型仓库。

评论

支持 Markdown