Documentation Index
Fetch the complete documentation index at: https://mintlify.com/jamdesk/jamdesk-cli/llms.txt
Use this file to discover all available pages before exploring further.
jamdesk migrate converts an existing Mintlify project to Jamdesk in a single command. Run it from inside your Mintlify docs directory and it will detect mint.json, convert your configuration and components, let you choose a theme, and copy everything into a new jamdesk-docs directory ready to develop against.
Usage
What gets converted
- Config —
mint.jsonis converted todocs.json, including navbar, navigation structure, footer, SEO settings, and appearance options. - Components — Deprecated Mintlify components are updated to their Jamdesk equivalents (for example,
<CardGroup>becomes<Columns>). - Inline components — Components that use
useStateoruseEffectare extracted into/snippetsas'use client'.tsxfiles. - Video embeds —
iframevideo embeds are normalized to the Jamdesk format.
Flags
| Flag | Description |
|---|---|
--yes, -y | Skip all confirmation prompts |
--theme <theme> | Pre-select a theme: jam, nebula, or pulsar |
--verbose | Print detailed output during the migration |
Full migration workflow
Navigate to your Mintlify docs directory
Change into the root of your existing Mintlify project — the directory that contains
mint.json.Run the migration command
Execute
jamdesk migrate. The CLI detects mint.json, converts your configuration to docs.json, and converts components.Pick a theme
When prompted, choose one of the three available Jamdesk themes:
jam, nebula, or pulsar. You can also pre-select a theme with the --theme flag to skip this prompt.