Quickstart: Deploy in 5 Minutes

Deploy a docs site with just two files: docs.json and one MDX page. Choose the path that matches your starting point.

Prerequisites

You'll need:

• A GitHub account
• A repository with your documentation (or we'll create one)

Option 1: Start from the Starter Template

The fastest way to get started. The starter template includes sample content, an OpenAPI spec, and examples of every component so you can see how things work before replacing them with your own content.

Option 2: Connect an Existing Repository

Already have a repo with Jamdesk-ready docs? Connect it directly. If you're moving from Mintlify or another docs platform, use Option 3 first.

Option 3: Migrate from Mintlify or Other Docs

Already have docs in Mintlify, GitBook, Docusaurus, ReadMe, Confluence, or another platform? Start with the migration guide before creating a new project. It covers the jamdesk migrate command for Mintlify and the manual steps for other documentation tools. After migration, connect the migrated repository using Option 2.

What's in a Docs Project

A minimal Jamdesk project has two things:

my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page

For larger sites, see Directory Structure for recommended folders, assets, and snippets.

docs.json

The configuration file that defines your site:

{
  "$schema": "https://jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction"]
      }
    ]
  }
}

See the docs.json Reference for all configuration options.

MDX Pages

Documentation pages written in MDX:

---
title: Introduction
description: Welcome to the docs
---

# Welcome

This is your first documentation page.

See MDX Basics for frontmatter, headings, links, and component syntax.

Local Development

The Jamdesk CLI lets you preview changes locally before pushing to GitHub. This is helpful for catching MDX syntax errors before they reach your live site. For all install methods and commands, see the Jamdesk CLI overview.

Preview changes locally:

npm install -g jamdesk
cd my-docs
jamdesk dev

Open http://localhost:3000 to see your docs with hot reload.

Add More Pages

1. Create a new MDX file:

---
title: Getting Started
description: Learn the basics
---

Your content here...

2. Add it to docs.json:

{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}

3. Push to GitHub - your new page deploys automatically.

For more linking patterns, including anchors and cards, see Links & Navigation.

Custom Domain

Add your own domain in Settings → Domains:

1. Enter your domain (e.g., docs.example.com)
2. Add the DNS records shown
3. Wait for verification (up to 48 hours)

SSL certificates are provisioned automatically. Full guide →

Need Help?

Stuck on something? Browse the Help Center for setup, billing, and troubleshooting guides. Or get a real person: open the chat widget in the bottom corner of any Jamdesk page, or email us at support@jamdesk.com. We answer fast.

What's Next?