Skip to content

claude-code-plugin.mdx

Latest commit

 

History

History
113 lines (87 loc) · 4.26 KB

claude-code-plugin.mdx

File metadata and controls

113 lines (87 loc) · 4.26 KB
title Claude Code Plugin
description Install the Jamdesk plugin for Claude Code to get AI assistance with MDX components, docs.json configuration, navigation patterns, and CLI commands.

Every time you ask Claude to write a Jamdesk page, you end up explaining the same things: which components exist, how docs.json works, what the CLI commands are. This plugin gives Claude Code that knowledge upfront, so you can skip the preamble and get straight to building.

You need Claude Code installed first. Get it at [claude.ai/code](https://claude.ai/code).

Installation

Run this slash command in Claude Code: 
```text
/plugin marketplace add jamdesk/jamdesk-claude-plugin
```
```text /plugin install jamdesk@jamdesk-marketplace ```

You can also find it by running /plugin and selecting Discover.

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

What's Included

One skill (/jamdesk:jamdesk) with a quick-reference hub and three detailed reference files that load on demand:

Reference What it covers
Components 25+ MDX components (Cards, Steps, Tabs, Callouts, Code Groups, Tables, and more) with complete props and examples
Configuration Full docs.json schema: themes, colors, branding, navbar, footer, API config, 20+ analytics integrations
Navigation 8 navigation patterns: flat, grouped, tabbed, multi-product, versioned, multi-language, dropdowns, OpenAPI

The hub also includes all 19 CLI commands, page frontmatter fields, image sizing syntax, writing standards, and common mistakes.

Usage

When you're working on Jamdesk docs, run /jamdesk:jamdesk.

If your project has a docs.json, Claude may activate the skill automatically.

Common questions (component syntax, CLI commands) get answered directly from the hub. Need full props tables, every config option, or navigation pattern details? Claude pulls in the specific reference file.

Example Prompts

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

Pairing with CLAUDE.md and MCP

Works best as part of a three-layer setup:

  1. The plugin teaches Claude about Jamdesk's platform: components, config, navigation, CLI.
  2. CLAUDE.md teaches Claude about your project's conventions — writing style, terminology, page structure.
  3. The MCP server gives Claude access to your published docs, so it can search, read content, and check existing pages.

You don't need all three. The plugin alone is useful. But paired with a CLAUDE.md and MCP connection, Claude can write pages that match your site's voice and link to your existing content without guessing.

Updating and Source

Check for updates by running /plugin in Claude Code. You can also re-run the install command to pull the latest version.

The plugin is open source (Apache 2.0). Browse source, file issues, or contribute: github.com/jamdesk/jamdesk-claude-plugin. Changelog.

What's Next?

CLAUDE.md template and MCP connection for your docs project Connect Claude to your published documentation