Skip to main content

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.

Running jamdesk migrate from inside your Mintlify docs directory is all it takes to move your documentation to Jamdesk. The command detects your existing mint.json, converts it to docs.json, walks you through picking a theme, and copies everything across — no manual editing required.

​
Before You Begin

Run jamdesk migrate from the root of your Mintlify project — the directory that contains your mint.json file. The command will not work from a parent or unrelated directory.

​
Migration Steps

1

Navigate to your Mintlify project

Open your terminal and change into the root directory of your Mintlify docs. This is the folder where mint.json lives.
cd /path/to/mintlify-docs
2

Run the migration command

Execute jamdesk migrate. The CLI detects your mint.json automatically, then converts and copies your content into a new jamdesk-docs directory.
jamdesk migrate
3

Choose a theme

When prompted, select one of the three available Jamdesk themes:
  • jam — clean and minimal
  • nebula — rich and modern
  • pulsar — bold and high-contrast
You can change your theme at any time by updating docs.json after migration.
4

Preview your migrated docs

Change into the newly created jamdesk-docs directory and start the local dev server to verify everything looks right.
cd jamdesk-docs
jamdesk dev
Your docs will be available at http://localhost:3000.

​
What Gets Converted

​
Config

mint.json is fully converted to docs.json. This covers your navbar, navigation tree, footer links, SEO metadata, and appearance settings. The structure maps cleanly — you won’t need to rebuild your navigation from scratch.

​
Components

Deprecated Mintlify components are automatically updated to their Jamdesk equivalents during migration. For example, <CardGroup> becomes <Columns>.

​
React Components

Inline components that use React hooks like useState or useEffect are extracted from your MDX files and saved as separate 'use client' .tsx files under the /snippets directory. This keeps your MDX files clean and ensures compatibility with Jamdesk’s rendering pipeline.

​
Video Embeds

iframe-based video embeds are detected and normalized to a consistent format during migration, so they render correctly in Jamdesk without manual adjustments.

​
Flags

FlagDescription
--yes, -ySkip all confirmation prompts and run non-interactively
--theme <theme>Pre-select a theme and skip the theme picker prompt. Accepted values: jam, nebula, pulsar
Use --yes together with --theme for fully automated migrations in CI pipelines or scripted environments — no interactive input required.
jamdesk migrate --yes --theme nebula

​
After Migration

Once the migration command completes, take a few minutes to validate and preview your docs before deploying.
  1. Validate — run jamdesk validate inside jamdesk-docs to catch any config or MDX issues surfaced during conversion.
  2. Preview — run jamdesk dev and review your docs at http://localhost:3000.
  3. Deploy — when everything looks good, run jamdesk deploy to publish.
For the complete list of what jamdesk migrate converts — including every component mapping and config key — see the full migration guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us