---
title: "Início rápido: deploy em 5 min"
sidebarTitle: Início rápido
description: "Crie um site de documentação Jamdesk e faça o deploy no seu subdomínio. Sem ferramentas de build: apenas GitHub e dois arquivos."
---

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

**O Jamdesk é um software de documentação** que publica um repositório GitHub de Markdown como um site de documentação hospedado, com saída legível por IA (`llms.txt`, endpoints `.md` por página e um servidor MCP) gerada automaticamente.

Faça o deploy de um site de documentação usando apenas dois arquivos: `docs.json` e uma página MDX. Escolha o caminho que corresponde ao seu ponto de partida.

## Pré-requisitos

Você precisará de:
- Uma conta do [GitHub](https://github.com)
- Um repositório com sua documentação (ou criaremos um para você)

## Opção 1: começar pelo template inicial

A maneira mais rápida de começar. O [template inicial](https://github.com/jamdesk/starter-docs) inclui conteúdo de exemplo, uma especificação OpenAPI e exemplos de todos os componentes, para que você veja como tudo funciona antes de substituí-los pelo seu próprio conteúdo.

<Steps>
  <Step title="Criar uma conta Jamdesk">
    Acesse [dashboard.jamdesk.com](https://dashboard.jamdesk.com) e cadastre-se com o GitHub.
  </Step>

  <Step title="Criar um projeto a partir do template">
    Clique em **New Project** → **From Template** → **Starter Docs**.

    O Jamdesk cria um repositório GitHub para você, com tudo pré-configurado.
  </Step>

  <Step title="Seu site está no ar">
    Sua documentação foi publicada em `your-project.jamdesk.app`. Edite os arquivos MDX, faça push e o site será compilado novamente de forma automática.
  </Step>
</Steps>

<Tip>
Você também pode clonar o template inicial diretamente: `git clone https://github.com/jamdesk/starter-docs.git my-docs`
</Tip>

<Tip>
**Quer manter algumas páginas privadas?** Adicione `private: true` ao frontmatter de qualquer arquivo MDX e defina uma senha em **Project Settings** após o próximo build. Consulte [Controle de acesso](/pt/setup/access-control) para conhecer as quatro opções (público, senha para todo o site, misto e SSO).
</Tip>

## Opção 2: conectar um repositório existente

Já tem um repositório com documentação pronta para o Jamdesk? Conecte-o diretamente. Se estiver migrando do Mintlify ou de outra plataforma de documentação, use a Opção 3 primeiro.

<Steps>
  <Step title="Criar uma conta Jamdesk">
    Acesse [dashboard.jamdesk.com](https://dashboard.jamdesk.com) e cadastre-se com o GitHub.
  </Step>

  <Step title="Criar um projeto">
    Clique em **New Project** e conecte seu repositório.

    1. Selecione seu repositório do GitHub
    2. Escolha a branch para o deploy
    3. O Jamdesk detecta seu `docs.json` automaticamente

    Se o seu repositório ainda não tiver `docs.json`, adicione o arquivo mínimo descrito em [O que há em um projeto de docs](#o-que-há-em-um-projeto-de-docs) antes de conectá-lo.

    Para saber mais sobre permissões do repositório, seleção de branch e caminhos da documentação, consulte [Conectar ao GitHub](/pt/setup/connecting-github).
  </Step>

  <Step title="Seu site está no ar">
    Sua documentação foi publicada em `your-project.jamdesk.app`, com `llms.txt` gerado automaticamente para que as ferramentas de IA possam ler sua documentação.

    Cada push para sua branch conectada aciona um novo build automático.
  </Step>
</Steps>

## Opção 3: migrar do Mintlify ou de outra plataforma

Já tem documentação no Mintlify, GitBook, Docusaurus, ReadMe, Confluence ou outra plataforma? Comece pelo guia de migração antes de criar um novo projeto. Ele aborda o comando `jamdesk migrate` para o Mintlify e as etapas manuais para outras ferramentas de documentação. Após a migração, conecte o repositório migrado usando a [Opção 2](#opção-2-conectar-um-repositório-existente).

<Columns cols={2}>
  <Card title="Guia de migração" icon="right-left" href="/pt/setup/migration">
    Converta a documentação do Mintlify ou migre manualmente de outra plataforma de documentação
  </Card>
</Columns>

## O que há em um projeto de docs

Um projeto Jamdesk mínimo tem dois elementos:

```bash
my-docs/
├── docs.json           # Configuration
└── introduction.mdx    # Your first page
```

Para sites maiores, consulte [Estrutura de diretórios](/pt/setup/directory-structure) para ver pastas, assets e snippets recomendados.

### docs.json

O arquivo de configuração que define seu site:

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

Consulte a [Referência do docs.json](/pt/config/docs-json-reference) para ver todas as opções de configuração.

### Páginas MDX

Páginas de documentação escritas em MDX:

```mdx
---
title: Introduction
description: Welcome to the docs
---

# Welcome

This is your first documentation page.
```

Consulte [Noções básicas de MDX](/pt/content/mdx-basics) para saber mais sobre frontmatter, títulos, links e sintaxe de componentes.

## Desenvolvimento local

A CLI do Jamdesk permite visualizar alterações localmente antes de fazer push para o GitHub. Isso ajuda a identificar erros de sintaxe MDX antes que eles cheguem ao seu site publicado. Para consultar todos os métodos de instalação e comandos, veja a [visão geral da CLI do Jamdesk](https://jamdesk.com/docs/cli/overview).

Visualize as alterações localmente:

<Tabs>
  <Tab title="npm">
    ```bash
    npm install -g jamdesk
    cd my-docs
    jamdesk dev
    ```
  </Tab>
  <Tab title="Homebrew">
    ```bash
    brew tap jamdesk/tap
    brew install jamdesk
    cd my-docs
    jamdesk dev
    ```
  </Tab>
  <Tab title="npx">
    ```bash
    cd my-docs
    npx jamdesk dev
    ```
  </Tab>
</Tabs>

Abra **http://localhost:3000** para ver sua documentação com hot reload.

## Adicionar mais páginas

1. Crie um novo arquivo MDX:

```mdx
---
title: Getting Started
description: Learn the basics
---

Your content here...
```

2. Adicione-o ao `docs.json`:

```json docs.json
{
  "navigation": {
    "groups": [
      {
        "group": "Getting Started",
        "pages": ["introduction", "getting-started"]
      }
    ]
  }
}
```

3. Faça push para o GitHub: sua nova página será publicada automaticamente.

Para ver mais padrões de links, incluindo âncoras e cards, consulte [Links e navegação](/pt/content/links).

## Domínio personalizado

Adicione seu próprio domínio em **Settings** → **Domains**:

1. Insira seu domínio (por exemplo, `docs.example.com`)
2. Adicione os registros DNS exibidos
3. Aguarde a verificação (até 48 horas)

Os certificados SSL são provisionados automaticamente. [Guia completo →](/pt/deploy/custom-domains)

## Precisa de ajuda?

Está com algum problema? Consulte a [Central de ajuda](/pt/help/overview) para ver guias de configuração, cobrança e solução de problemas. Ou fale com uma pessoa: abra o widget de chat no canto inferior de qualquer página do Jamdesk ou envie um e-mail para [support@jamdesk.com](mailto:support@jamdesk.com). Respondemos rapidamente.

## Referência completa

Tudo o que você pode criar e executar está em três referências: cada [componente](/pt/components/overview) MDX, cada [comando da CLI](/pt/cli/overview) e cada [opção de configuração do `docs.json`](/pt/config/docs-json-reference).

## O que vem a seguir?

<Columns cols={2}>
  <Card title="Tutorial completo" icon="route" href="/pt/end-to-end-tutorial">
    Fluxo completo, da configuração ao domínio personalizado
  </Card>
  <Card title="Noções básicas de MDX" icon="file-code" href="/pt/content/mdx-basics">
    Escreva documentação em MDX
  </Card>
  <Card title="Componentes" icon="puzzle-piece" href="/pt/components/overview">
    Explore os componentes disponíveis
  </Card>
  <Card title="Referência de configuração" icon="gear" href="/pt/config/docs-json-reference">
    Todas as opções do docs.json
  </Card>
</Columns>