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 init is the fastest way to get a Jamdesk documentation project off the ground. It generates a docs.json configuration file, a set of starter MDX pages, and a navigation scaffold — everything you need to open your browser and start writing in under a minute.

​
Usage

jamdesk init [name]
name is optional. When provided, a new subdirectory with that name is created and the project is scaffolded inside it. When omitted, the project is scaffolded directly in the current working directory.

​
What it creates

Running jamdesk init produces the following structure:
  • docs.json — the central configuration file for your project. Controls navigation, theme, branding, integrations, and SEO.
  • Starter MDX files — a minimal set of pages (such as a quickstart and an overview) so you have real content to preview immediately.
  • Navigation scaffold — the docs.json navigation section is pre-populated to match the starter pages, so the sidebar works out of the box.

​
Example

jamdesk init my-docs
cd my-docs
jamdesk dev
This creates a my-docs/ directory, scaffolds the project inside it, and launches the local development server. Your docs are available at http://localhost:3000 within seconds.

​
Scaffolding into the current directory

If you are already inside an empty directory (or want to add Jamdesk docs to an existing repo root), omit the name argument: 
mkdir my-docs && cd my-docs
jamdesk init
jamdesk dev
The command will not overwrite files that already exist, so it is safe to run inside a repository that has other content.

​
After init: preview locally

Once scaffolding completes, start the local development server to preview your docs: 
jamdesk dev
The server starts at http://localhost:3000 with hot reload enabled — every save is reflected in the browser instantly.
Ready to go further? Follow the Quickstart guide to connect your project to Jamdesk hosting, enable AI search, and deploy your docs globally.

Build docs developers (and LLMs) love

Get started for freeTalk to us