Creating Projects
Create and configure your documentation project in the Jamdesk dashboard
Projects are the foundation of your Jamdesk documentation. Each project connects to a GitHub repository and deploys to its own domain.
Create a New Project
1
Sign in to JamdeskGo to app.jamdesk.com and sign in with your GitHub account.
First-time users will be prompted to authorize the Jamdesk GitHub App.
2
Click New ProjectFrom the dashboard, click New Project in the top right corner.
3
Choose a starting pointStart with a pre-built template:
- Docs - General documentation with guides and references
- API Reference - API documentation with endpoint examples
- Knowledge Base - FAQ and help center style
Jamdesk creates a new GitHub repository with the template content.
Connect an existing GitHub repository:
- Select the repository from the dropdown
- Choose the branch to deploy (usually
main) - Specify the path to
docs.jsonif not in the root
4
Configure project settingsSet 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.dev subdomain |
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.devURL - Custom Domain - Add your own domain
- Host at /docs - Serve docs at
/docspath instead of root
Build
- Environment Variables - Set build-time variables
- Rebuild - Manually trigger a new build
Project Limits
| Plan | Projects | Builds/Month |
|---|---|---|
| Free | 1 | 100 |
| Pro | 10 | Unlimited |
| Team | Unlimited | Unlimited |