---
title: Criar um projeto
description: Crie um projeto do Jamdesk a partir de um template ou conecte um repositório GitHub existente e publique seu site em poucos minutos.
---

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

Antes de escrever qualquer documentação, você precisa de um projeto. É possível começar com um template (o Jamdesk cria o repositório GitHub para você) ou conectar um repositório existente que já tenha um `docs.json`. Em ambos os casos, você terá um site disponível em poucos minutos.

## Criar um novo projeto

<Steps>
  <Step title="Faça login no Jamdesk">
    Acesse [dashboard.jamdesk.com](https://dashboard.jamdesk.com) e faça login com sua conta do GitHub.

    Usuários que acessarem pela primeira vez receberão uma solicitação para autorizar o aplicativo GitHub do Jamdesk.
  </Step>

  <Step title="Clique em New Project">
    No dashboard, clique em **New Project** no canto superior direito.
  </Step>

  <Step title="Escolha um ponto de partida">
    <Tabs>
      <Tab title="From Template">
        Comece com um template pré-configurado. O Jamdesk cria um novo repositório GitHub para você, com conteúdo de exemplo, navegação e componentes já configurados.

        O [Starter Template](https://github.com/jamdesk/starter-docs) padrão inclui páginas de exemplo, uma especificação OpenAPI e exemplos de todos os componentes. Substitua o conteúdo pelo seu próprio e pronto.
      </Tab>
      <Tab title="From Repository">
        Conecte um repositório GitHub existente:

        1. Selecione o repositório no menu suspenso
        2. Escolha a branch a ser implantada (geralmente `main`)
        3. Especifique o caminho para `docs.json` se ele não estiver na raiz
      </Tab>
    </Tabs>
  </Step>

  <Step title="Configure as configurações do projeto">
    Defina as informações básicas do seu projeto:

    | Campo | Descrição |
    |-------|-------------|
    | **Name** | Nome de exibição mostrado no dashboard |
    | **Slug** | Identificador compatível com URLs (por exemplo, `my-docs`) |
    | **Domain** | Seu subdomínio `*.jamdesk.app` |
  </Step>
</Steps>

## Estrutura mínima do repositório

Um projeto do Jamdesk precisa apenas de um `docs.json` e pelo menos uma página:

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

Exemplo de `docs.json`:

```json docs.json
{
  "$schema": "https://jamdesk.com/docs.json",
  "name": "My Docs",
  "theme": "jam",
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction"]
      }
    ]
  }
}
```

## Configurações do projeto

Após a criação, configure seu projeto em **Settings**:

### General

- **Name** - Atualize o nome de exibição
- **Slug** - Altere o identificador do projeto
- **Delete Project** - Remova o projeto permanentemente

### Repository

- **Branch** - Branch que inicia as implantações
- **Docs Path** - Localização de `docs.json` para monorepos

### Domain

- **Subdomain** - Sua URL `*.jamdesk.app`
- **Custom Domain** - Adicione seu próprio domínio
- **Host at a subpath** - Disponibilize a documentação em um caminho como `/docs` ou `/help`, em vez da raiz do site

### Build

- **Show Jamdesk Branding** - Exiba o link "Powered by Jamdesk" no rodapé (ativado por padrão)
- **Rebuild** - Inicie manualmente um novo build

<Note>
As alterações nas configurações de build exigem um novo build para entrarem em vigor.
</Note>

## Limites do projeto

| Plano | Projetos | Builds/mês |
|------|----------|--------------|
| Free | 1 | 100 |
| Pro | 10 | Ilimitados |
| Team | Ilimitados | Ilimitados |

## O que vem a seguir?

<Columns cols={2}>
  <Card title="Conectar ao GitHub" icon="github" href="/pt/setup/connecting-github">
    Vincule seu repositório para habilitar builds automáticos
  </Card>
  <Card title="Estrutura de diretórios" icon="folder-tree" href="/pt/setup/directory-structure">
    Organize sua documentação para crescer com facilidade
  </Card>
  <Card title="Configuração de monorepo" icon="folders" href="/pt/setup/monorepo-support">
    Configure o caminho da documentação para monorepos
  </Card>
  <Card title="Tutorial completo" icon="route" href="/pt/end-to-end-tutorial">
    Siga o fluxo de trabalho completo do Jamdesk
  </Card>
</Columns>