---
title: Create a Project
description: Create a Jamdesk project from a template or connect an existing GitHub repo. Your site goes live at yourproject.jamdesk.app within minutes.
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

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

<Steps>
  <Step title="Sign in to Jamdesk">
    Go to [dashboard.jamdesk.com](https://dashboard.jamdesk.com) and sign in with your GitHub account.

    First-time users will be prompted to authorize the Jamdesk GitHub App.
  </Step>

  <Step title="Click New Project">
    From the dashboard, click **New Project** in the top right corner.
  </Step>

  <Step title="Choose a starting point">
    <Tabs>
      <Tab title="From Template">
        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](https://github.com/jamdesk/starter-docs) includes sample pages, an OpenAPI spec, and examples of every component — replace the content with your own and you're done.
      </Tab>
      <Tab title="From Repository">
        Connect an existing GitHub repository:

        1. Select the repository from the dropdown
        2. Choose the branch to deploy (usually `main`)
        3. Specify the path to `docs.json` if not in the root
      </Tab>
    </Tabs>
  </Step>

  <Step title="Configure project settings">
    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 |
  </Step>
</Steps>

## Minimal Repository Structure

A Jamdesk project only needs a `docs.json` and at least one page:

```bash
my-docs/
├── docs.json
└── introduction.mdx
```

Example `docs.json`:

```json 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.json` for monorepos

### Domain

- **Subdomain** - Your `*.jamdesk.app` URL
- **Custom Domain** - Add your own domain
- **Host at /docs** - Serve docs at `/docs` path instead of root

### Build

- **Show Jamdesk Branding** - Display "Powered by Jamdesk" link in your footer (enabled by default)
- **Rebuild** - Manually trigger a new build

<Note>
Build setting changes require a new build to take effect.
</Note>

## Project Limits

| Plan | Projects | Builds/Month |
|------|----------|--------------|
| Free | 1 | 100 |
| Pro | 10 | Unlimited |
| Team | Unlimited | Unlimited |

## What's Next?

<Columns cols={2}>
  <Card title="Connect GitHub" icon="github" href="/setup/connecting-github">
    Link your repository for automatic builds
  </Card>
  <Card title="Directory Structure" icon="folder-tree" href="/setup/directory-structure">
    Organize your docs for scale
  </Card>
  <Card title="Monorepo Setup" icon="folders" href="/setup/monorepo-support">
    Configure docs path for monorepos
  </Card>
  <Card title="End-to-End Tutorial" icon="route" href="/end-to-end-tutorial">
    Follow the complete Jamdesk workflow
  </Card>
</Columns>