Quickstart
Deploy your first documentation site in 5 minutes
Get your docs live in three steps. No complex configuration required.
Prerequisites
You'll need:
- A GitHub account
- A repository with your documentation (or we'll create one)
Deploy Your Docs
Go to app.jamdesk.com and sign up with GitHub.
This connects your GitHub account so Jamdesk can access your repositories.
Click New Project and choose one of:
Start with a pre-built template. Perfect for getting started quickly.
- Select a template (Docs, API Reference, or Knowledge Base)
- Name your project
- Jamdesk creates a GitHub repository for you
Already have documentation? Connect your repository.
- Select your GitHub repository
- Choose the branch to deploy
- Jamdesk detects your
docs.jsonautomatically
That's it. Your docs are deployed to your-project.jamdesk.dev.
Every push to your connected branch triggers an automatic rebuild.
What's in a Docs Project
A minimal Jamdesk project has two things:
my-docs/
├── docs.json # Configuration
└── introduction.mdx # Your first page
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"]
}
]
}
}MDX Pages
Documentation pages written in MDX:
---
title: Introduction
description: Welcome to the docs
---
# Welcome
This is your first documentation page.Local Development
Preview changes before pushing:
npm install -g jamdesk
cd my-docs
jamdesk devcd my-docs
npx jamdesk devOpen http://localhost:3000 to see your docs with hot reload.
Add More Pages
- Create a new MDX file:
---
title: Getting Started
description: Learn the basics
---
Your content here...- Add it to
docs.json:
{
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction", "getting-started"]
}
]
}
}- Push to GitHub - your new page deploys automatically.
Custom Domain
Add your own domain in Settings → Domains:
- Enter your domain (e.g.,
docs.example.com) - Add the DNS records shown
- Wait for verification (up to 48 hours)
SSL certificates are provisioned automatically.