Jamdesk Documentation logo

Claude Code 插件

为 Claude Code 安装 Jamdesk 插件,获取 MDX 组件、docs.json 配置、导航模式和 CLI 命令的 AI 辅助。

本插件为 Claude Code 提供 Jamdesk 相关知识,省去你在每次提问时都要重新解释的内容:有哪些组件、docs.json 如何工作、CLI 命令是什么。

你需要先安装 Claude Code。可在 claude.ai/code 获取。

安装

1
添加插件市场

在 Claude Code 中运行以下斜杠命令:

/plugin marketplace add jamdesk/jamdesk-claude-plugin
2
安装插件
/plugin install jamdesk@jamdesk-marketplace

你也可以运行 /plugin 并选择 Discover 来找到它。

git clone https://github.com/jamdesk/jamdesk-claude-plugin.git
claude --plugin-dir ./jamdesk-claude-plugin

包含内容

该插件提供一个技能 /jamdesk:jamdesk。它包含一个快速参考中心,以及三个按需加载的参考文件:

参考涵盖内容
Components25+ 个 MDX 组件(Cards、Steps、Tabs、Callouts、Code Groups、Tables 等),含完整属性和示例
Configuration完整的 docs.json 结构:主题、颜色、品牌、导航栏、页脚、API 配置,以及 20+ 个分析集成
Navigation8 种导航模式:扁平、分组、标签页、多产品、版本化、多语言、下拉菜单、OpenAPI

中心还列出 19 个 CLI 命令、页面 frontmatter 字段、图片尺寸语法、编写规范以及常见错误。

使用方法

在编写 Jamdesk 文档时运行 /jamdesk:jamdesk。

在包含 docs.json 的项目中,Claude 可能会自动激活该技能。

对于组件语法和 CLI 命令等常见问题,Claude 会直接从参考中心作答。如需完整的属性表、配置选项或导航模式细节,它会加载对应的参考文件。

示例提示词

Create a quickstart page with Steps, a CodeGroup for
install commands, and a Warning about prerequisites.

与 CLAUDE.md 和 MCP 配合使用

该插件在三层架构下效果最佳:

  1. 插件让 Claude 了解 Jamdesk 平台:组件、配置、导航、CLI。
  2. CLAUDE.md 让 Claude 了解你项目的约定:写作风格、术语、页面结构。
  3. MCP 服务器 让 Claude 能够搜索并读取你已发布的文档。

三者并非都必需。插件本身已经有用。配合 CLAUDE.md 和 MCP 连接,Claude 还能匹配你站点的文风,并链接到现有页面。

更新和源代码

在 Claude Code 中运行 /plugin 即可检查更新。你也可以重新运行安装命令来拉取最新版本。

该插件是开源的(Apache 2.0)。可浏览源码、提交问题或参与贡献:github.com/jamdesk/jamdesk-claude-plugin。更新日志。

接下来做什么?

Claude Code 设置

为你的文档项目准备的 CLAUDE.md 模板与 MCP 连接

MCP Server

将 Claude 连接到你已发布的文档