Back to the catalog

jamdesk

Gives Claude deep knowledge of the Jamdesk documentation platform — 25+ MDX components with full props and examples, complete docs.json conf

Open source Repository Open in the app JSON README (API)

About

Gives Claude deep knowledge of the Jamdesk documentation platform — 25+ MDX components with full props and examples, complete docs.json configuration schema, 8 navigation patterns, 19 CLI commands, and writing standards. Claude loads only the reference sections relevant to each task, keeping context efficient.

Details

Kind
Plugins
Topic
Developer tools
Publisher
jamdesk
Origin
marketplace
Category
ferramentas
Stars
3
Open pull requests
2
Last push
2026-08-20T22:09:57Z
Repository state
ativo
License
Apache-2.0
Added
2026-08-30 01:48:58
Updated
2026-08-30 01:48:58
Origin id
jamdesk/jamdesk-claude-plugin/jamdesk

README

# Jamdesk Claude Code Plugin

A Claude Code plugin for building [Jamdesk](https://www.jamdesk.com) documentation sites. Gives Claude deep knowledge of Jamdesk components, configuration, navigation patterns, and CLI commands — so you can build docs faster with AI assistance.

## Installation

### From Claude Code Marketplace

```
/plugin marketplace add jamdesk/jamdesk-claude-plugin
/plugin install jamdesk@jamdesk-marketplace
```

### Manual (for development/testing)

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

## Usage

Invoke the skill when working on Jamdesk documentation:

```
/jamdesk:jamdesk
```

Claude reads only the sections relevant to your task — the hub provides quick answers, and reference files load on demand for deep dives.

**New to Jamdesk?** Get started:

```bash
npm install -g jamdesk
jamdesk init my-docs && cd my-docs
jamdesk dev
```

## What's Included

One skill with a quick-reference hub and three detailed reference files:

| Reference | Contents |
|-----------|----------|
| **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 |

Plus: CLI command reference (19 commands), page frontmatter fields, image sizing syntax, writing standards, common mistakes, and an MCP server integration for querying Jamdesk documentation.

## What is Jamdesk?

[Jamdesk](https://www.jamdesk.com) is a documentation platform for building beautiful, fast documentation sites from MDX files.

- **Four themes** — Jam, Nebula, Pulsar, Halo (all with dark mode)
- **25+ MDX components** — Cards, Steps, Tabs, Code Groups, Tables, API fields, color palettes, and more
- **OpenAPI & AsyncAPI** — Auto-generated API reference with interactive playground
- **AI Chat** — Built-in AI assistant trained on your docs content
- **Global CDN** — Fast deploys to Cloudflare R2 + Vercel Edge
- **CLI tooling** — Local dev server, validation, spellcheck, broken link detection
- **Migrate from Mintlify** — Run `jamdesk migrate` to convert `mint.json` → `docs.json` and update component syntax
- **Custom domains** — Host at `docs.yoursite.com` or `yoursite.com/docs`
- **Analytics** — Built-in dashboard + 20+ integrations (GA4, Plausible, PostHog, Amplitude, etc.)
- **Search** — Full-text search with keyboard navigation, out of the box

Learn more at [jamdesk.com](https://www.jamdesk.com) or read the [documentation](https://www.jamdesk.com/docs).

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for how to keep the reference files up to date as Jamdesk evolves.

## License

Apache 2.0 — see [LICENSE](LICENSE).

More