mcpField
M
mastra-docs

mastra-docs

github.com/mastra-ai文档处理29.2k158 次安装今天更新
代码仓库

关于 mastra-docs

面向 Mastra 文档贡献者的写作指南,按页面类型指向通用规范及专门参考,涵盖内容结构、组件、图表和编辑流程。

主要功能

  1. 01写作规范与信息架构参考
  2. 02docs、integrations 和 reference 页面指南
  3. 03共享 MDX 组件说明
  4. 04Mermaid 图表规范
  5. 05编辑、重定向与验证指引

适用场景

  1. 01起草或修订 Mastra 文档
  2. 02确定内容的规范归属位置和路由
  3. 03创建或更新文档图表

安装

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

$npx skills add https://github.com/mastra-ai/mastra --skill mastra-docs

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

包含的文件

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

references/
AUTHORING_WORKFLOW.md
COMPONENTS.md
DIAGRAM.md
DOC.md
GUIDE_INTEGRATION.md
INFORMATION_ARCHITECTURE.md
REFERENCE.md
STYLEGUIDE.md

详细介绍

Mastra 文档指南

请遵循最具体的 AGENTS.md,并参考以下资料:

  1. references/STYLEGUIDE.md:全局写作、准确性、链接、代码和无障碍规则。
  2. references/INFORMATION_ARCHITECTURE.md:内容系列、规范归属、侧边栏和路由。
  3. 选择页面指南:
    • references/DOC.md:/docs 下的页面。
    • references/GUIDE_INTEGRATION.md:/integrations 下的页面。
    • references/REFERENCE.md:/reference 下的页面。
  4. references/COMPONENTS.md:共享 MDX 组件和 llms-txt 标记。
  5. references/DIAGRAM.md:Mermaid 图表的形状、颜色、布局、标签和无障碍要求。
  6. references/AUTHORING_WORKFLOW.md:编辑、移动、删除、重定向和验证。

要用 Mermaid 替换现有的图表图片,请使用 docs-diagrams Skill。

请将页面模式视为指导而非固定模板。应符合读者的任务和当前章节的惯例。

评论

支持 Markdown