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.

Jamdesk is a docs-as-code platform built for teams that want their documentation to live alongside their code. You write in MDX, run a local dev server with instant hot reload, and deploy to a global CDN in seconds — with AI search, analytics, and custom domains included out of the box. Whether you’re a solo developer or a large engineering team, the Jamdesk CLI gives you the speed and confidence to ship great docs.

What is Jamdesk?

Jamdesk is a fully managed documentation hosting platform centered on the docs-as-code workflow. Connect a GitHub repository, author your content in MDX, and Jamdesk handles the rest: global deployment, AI-powered full-text search, usage analytics, and custom domain management. The CLI is your local companion — it powers the dev server, validates your config and content, catches broken links and spelling mistakes, and can migrate your existing docs from other platforms in a single command.
  • Docs-as-code workflow — your docs live in version control, reviewed in pull requests, and deployed through the same pipelines as your code
  • MDX-based authoring — mix Markdown prose with 50+ purpose-built React components, including accordions, tabs, code groups, callouts, and more
  • Global deployment — every deploy lands on a CDN-backed *.jamdesk.app subdomain with SSL included; bring your own custom domain when you’re ready
  • AI search — full-text search works in the local dev server; hosted sites upgrade to AI-powered semantic search automatically

Key Features

Dev Server

Turbopack-powered local preview with hot reload on every save. Validates config and MDX on startup so you catch issues before they reach production.

Configuration

Everything — themes, navigation, branding, analytics, OpenAPI, and SEO — lives in a single docs.json file at the root of your project.

50+ MDX Components

Accordions, tabs, code groups, callouts, steps, cards, and more. All components work identically in the local dev server and on hosted sites.

OpenAPI Reference

Auto-generate API reference pages directly from your OpenAPI specs. Validate specs before deploy with jamdesk openapi-check.

Deploy

Deploy from the CLI with jamdesk deploy, or connect your GitHub repo for automatic builds on every push. Supports subpath hosting via Cloudflare Workers.

Migrate from Mintlify

Move your existing Mintlify docs to Jamdesk in one command. Config, components, and content are converted automatically.

How It Works

You write your content as MDX files — standard Markdown with optional React components dropped in wherever you need richer formatting. Running jamdesk dev starts a Turbopack-powered local server at http://localhost:3000 where you can see your site exactly as it will appear in production, with changes reflecting instantly on every save. When you’re ready to go live, jamdesk deploy packages your project, uploads it, and triggers a cloud build; your updated docs are live within seconds. For teams using GitHub, connecting your repository enables fully automatic deploys on every push — no manual step required. Ready to get started? Head to the Quickstart to have a working docs site running in under two minutes.

Build docs developers (and LLMs) love