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 that lets you write documentation in MDX, preview it locally with the CLI, and deploy it globally in seconds. The CLI is your local development environment — start a hot-reloading dev server, validate your config, catch broken links, and push to production.

Installation

Install the Jamdesk CLI via npm, Homebrew, or the one-liner installer.

Quickstart

Create your first docs project and launch the dev server in under two minutes.

Command Reference

Every CLI command, flag, and option documented with real examples.

Configuration

Configure themes, navigation, branding, and integrations in docs.json.

What Jamdesk gives you

Dev Server

Turbopack-powered with hot reload — roughly 5× faster than Webpack. Full search and all themes work locally.

50+ MDX Components

Accordions, tabs, code groups, callouts, and more — all ready to use in any MDX file.

OpenAPI Integration

Point to your OpenAPI spec and Jamdesk auto-generates a full API reference.

Mintlify Migration

Migrate from Mintlify in a single command — config, components, and content all converted.

Deployment

Deploy via CLI or connect a GitHub repo for automatic builds on every push.

Validation

Catch MDX syntax errors, broken links, and config issues before you deploy.

Get up and running

1

Install the CLI

npm install -g jamdesk
2

Create a new project

jamdesk init my-docs
cd my-docs
3

Start the dev server

jamdesk dev
Your docs are live at http://localhost:3000 with hot reload on every save.
4

Deploy to production

jamdesk login
jamdesk deploy
Jamdesk packages and uploads your docs, then shows live build progress until your site is live.
Jamdesk requires Node.js v20.0.0 or later. Run node --version to check. See Requirements for the full list.

Build docs developers (and LLMs) love