Create a Project
Create a Jamdesk project from a template or connect an existing GitHub repo. Your site goes live at yourproject.jamdesk.app within minutes.
Before writing any docs you need a project. You can start from a template (Jamdesk creates the GitHub repo for you) or connect an existing repository that already has a docs.json. Either way, you will have a live site within a few minutes.
Create a New Project
Go to dashboard.jamdesk.com and sign in with your GitHub account.
First-time users will be prompted to authorize the Jamdesk GitHub App.
From the dashboard, click New Project in the top right corner.
Start with a pre-built template. Jamdesk creates a new GitHub repository for you with sample content, navigation, and components already configured.
The default Starter Template includes sample pages, an OpenAPI spec, and examples of every component — replace the content with your own and you're done.
Set your project's basic information:
| Field | Description |
|---|---|
| Name | Display name shown in the dashboard |
| Slug | URL-friendly identifier (e.g., my-docs) |
| Domain | Your *.jamdesk.app subdomain |
Minimal Repository Structure
A Jamdesk project only needs a docs.json and at least one page:
my-docs/
├── docs.json
└── introduction.mdx
Example docs.json:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Project Settings
After creation, configure your project in Settings:
General
- Name - Update the display name
- Slug - Change the project identifier
- Delete Project - Permanently remove the project
Repository
- Branch - Which branch triggers deployments
- Docs Path - Location of
docs.jsonfor monorepos
Domain
- Subdomain - Your
*.jamdesk.appURL - Custom Domain - Add your own domain
- Host at /docs - Serve docs at
/docspath instead of root
Build
- Show Jamdesk Branding - Display "Powered by Jamdesk" link in your footer (enabled by default)
- Rebuild - Manually trigger a new build
Build setting changes require a new build to take effect.
Project Limits
| Plan | Projects | Builds/Month |
|---|---|---|
| Free | 1 | 100 |
| Pro | 10 | Unlimited |
| Team | Unlimited | Unlimited |