---
title: Claude Code 插件
description: 安装 Jamdesk 的 Claude Code 插件，获得有关 MDX 组件、docs.json 配置、导航模式和 CLI 命令的 AI 辅助。
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

每次让 Claude 编写 Jamdesk 页面时，你都要反复说明相同的内容：有哪些组件、`docs.json` 如何工作，以及 CLI 命令是什么。此插件预先为 [Claude Code](https://claude.ai/code) 提供这些知识，让你跳过冗长的前置说明，直接开始构建。

<Note>
  你需要先安装 Claude Code。请从 [claude.ai/code](https://claude.ai/code) 获取。
</Note>

## 安装

<Steps>
  <Step title="Add the marketplace">
    在 Claude Code 中运行此斜杠命令：

    ```text
    /plugin marketplace add jamdesk/jamdesk-claude-plugin
    ```
  </Step>
  <Step title="Install the plugin">
    ```text
    /plugin install jamdesk@jamdesk-marketplace
    ```
  </Step>
</Steps>

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

<Accordion title="Manual install (for development or testing)">
  ```bash
  git clone https://github.com/jamdesk/jamdesk-claude-plugin.git
  claude --plugin-dir ./jamdesk-claude-plugin
  ```
</Accordion>

## 包含内容

一个技能（`/jamdesk:jamdesk`），包含一个快速参考中心和三个按需加载的详细参考文件：

| 参考文件 | 涵盖内容 |
|-----------|---------------|
| **组件** | 25+ 个 MDX 组件（Cards、Steps、Tabs、Callouts、Code Groups、Tables 等），包含完整的属性和示例 |
| **配置** | 完整的 `docs.json` schema：主题、颜色、品牌、导航栏、页脚、API 配置以及 20+ 个分析集成 |
| **导航** | 8 种导航模式：扁平、分组、标签页、多产品、版本化、多语言、下拉菜单和 OpenAPI |

该中心还包含全部 19 个 CLI 命令、页面 frontmatter 字段、图像尺寸语法、写作规范和常见错误。

## 使用方法

处理 Jamdesk 文档时，运行 `/jamdesk:jamdesk`。

如果项目中有 `docs.json`，Claude 可能会自动激活此技能。

常见问题（组件语法、CLI 命令）会直接由该中心解答。如果需要完整的属性表、每个配置选项或导航模式的详细信息，Claude 会加载相应的参考文件。

## 示例提示词

<Tabs>
  <Tab title="Components">
    ```text
    Create a quickstart page with Steps, a CodeGroup for
    install commands, and a Warning about prerequisites.
    ```
  </Tab>
  <Tab title="Configuration">
    ```text
    Add Plausible analytics and customize the navbar with
    a GitHub link and a "Get Started" button.
    ```
  </Tab>
  <Tab title="Navigation">
    ```text
    Convert my flat navigation into tabbed navigation with
    a "Guides" tab and an "API" tab that auto-generates
    pages from openapi.yaml.
    ```
  </Tab>
  <Tab title="CLI">
    ```text
    What Jamdesk CLI commands should I run before deploying
    to catch issues?
    ```
  </Tab>
</Tabs>

## 与 CLAUDE.md 和 MCP 配合使用

作为三层设置的一部分时效果最佳：

1. 此插件向 Claude 介绍 Jamdesk 平台：组件、配置、导航和 CLI。
2. [CLAUDE.md](/cn/ai/claude-code) 向 Claude 介绍*你的项目*规范：写作风格、术语和页面结构。
3. [MCP server](/cn/ai/mcp-server) 让 Claude 能够访问已发布的文档，从而搜索、阅读内容并检查现有页面。

你不需要三者齐备。仅使用此插件也很有用。但将其与 CLAUDE.md 和 MCP 连接配合使用后，Claude 可以编写符合你网站语气的页面，并链接到现有内容，而无需猜测。

## 更新和源代码

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

此插件采用 Apache 2.0 许可证开源。浏览源代码、提交问题或参与贡献：[github.com/jamdesk/jamdesk-claude-plugin](https://github.com/jamdesk/jamdesk-claude-plugin)。查看 [Changelog](https://github.com/jamdesk/jamdesk-claude-plugin/blob/main/CHANGELOG.md)。

## 接下来做什么？

<Columns cols={2}>
  <Card title="Claude Code 设置" icon="terminal" href="/cn/ai/claude-code">
    适用于文档项目的 CLAUDE.md 模板和 MCP 连接
  </Card>
  <Card title="MCP server" icon="robot" href="/cn/ai/mcp-server">
    将 Claude 连接到已发布的文档
  </Card>
</Columns>