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.
You need a project before you write any docs. Start from a template to have Jamdesk create the repo on GitHub or Bitbucket Cloud. Or connect an existing repository that already has a docs.json. Your site goes live within a few minutes. To start without a GitHub account, see Docs Without GitHub.
Create a New Project
Go to dashboard.jamdesk.com and sign in with your GitHub account.
Jamdesk prompts you to authorize the Jamdesk GitHub App on first sign-in.
From the dashboard, click New Project in the top right corner.
Start with a pre-built template. Jamdesk creates a new GitHub repository 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.
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.mdxExample docs.json:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Project Settings
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 a subpath: serve docs at a path like
/docsor/helpinstead of the site 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
The Pro plan includes one project. Add more with project add-ons at $15/month each.