--- title: "Quickstart: Deploy in 5 Minutes" sidebarTitle: Quickstart description: Create a Jamdesk docs site and deploy it to your subdomain. No build tools required—just GitHub and two files. --- 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](https://github.com) 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](https://github.com/jamdesk/starter-docs) 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. Go to [dashboard.jamdesk.com](https://dashboard.jamdesk.com) and sign up with GitHub. Click **New Project** → **From Template** → **Starter Docs**. Jamdesk creates a GitHub repository for you with everything pre-configured. Your docs are deployed to `your-project.jamdesk.app`. Edit the MDX files, push, and the site rebuilds automatically. You can also clone the starter directly: `git clone https://github.com/jamdesk/starter-docs.git my-docs` ## 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. Go to [dashboard.jamdesk.com](https://dashboard.jamdesk.com) and sign up with GitHub. Click **New Project** and connect your repository. 1. Select your GitHub repository 2. Choose the branch to deploy 3. Jamdesk detects your `docs.json` automatically If your repo doesn't have `docs.json` yet, add the minimal file from [What's in a Docs Project](#what-s-in-a-docs-project) before connecting it. For repository permissions, branch selection, and docs paths, see [Connect GitHub](/setup/connecting-github). Your docs are deployed to `your-project.jamdesk.app` with `llms.txt` auto-generated so AI tools can read your docs. Every push to your connected branch triggers an automatic rebuild. ## 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](#option-2-connect-an-existing-repository). Convert Mintlify docs or manually migrate from another docs platform ## What's in a Docs Project A minimal Jamdesk project has two things: ```bash my-docs/ ├── docs.json # Configuration └── introduction.mdx # Your first page ``` For larger sites, see [Directory Structure](/setup/directory-structure) for recommended folders, assets, and snippets. ### docs.json The configuration file that defines your site: ```json { "$schema": "https://jamdesk.com/docs.json", "name": "My Docs", "theme": "jam", "navigation": { "groups": [ { "group": "Getting Started", "pages": ["introduction"] } ] } } ``` See the [docs.json Reference](/config/docs-json-reference) for all configuration options. ### MDX Pages Documentation pages written in MDX: ```mdx --- title: Introduction description: Welcome to the docs --- # Welcome This is your first documentation page. ``` See [MDX Basics](/content/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](https://jamdesk.com/docs/cli/overview). Preview changes locally: ```bash npm install -g jamdesk cd my-docs jamdesk dev ``` ```bash brew tap jamdesk/tap brew install jamdesk cd my-docs jamdesk dev ``` ```bash cd my-docs npx jamdesk dev ``` Open **http://localhost:3000** to see your docs with hot reload. ## Add More Pages 1. Create a new MDX file: ```mdx --- title: Getting Started description: Learn the basics --- Your content here... ``` 2. Add it to `docs.json`: ```json 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](/content/links). ## 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 →](/deploy/custom-domains) ## Need Help? Stuck on something? Browse the [Help Center](/help/overview) 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](mailto:support@jamdesk.com). We answer fast. ## What's Next? Full workflow from setup to custom domain Write documentation in MDX Explore available components All docs.json options