---
title: Tutorial de ponta a ponta
description: "Do repositório vazio ao site de documentação no ar: crie um projeto, visualize localmente, faça deploy e configure opcionalmente um domínio personalizado."
---

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

Passe de um repositório vazio a um site de documentação no ar. Adicione um domínio personalizado quando estiver pronto e ignore as etapas que já tiver concluído.

## Pré-requisitos

- Uma conta do GitHub
- Um repositório com conteúdo de documentação (ou use o [Modelo inicial](https://github.com/jamdesk/starter-docs))
- Node.js 20+ se quiser instalar a CLI com npm

<Steps>
  <Step title="Crie um projeto e conecte o GitHub">
    Crie seu primeiro projeto no dashboard do Jamdesk e conecte um repositório.

    - Siga [Criar projetos](/pt/setup/creating-projects) para definir o nome, o slug e o caminho da documentação do projeto
    - Se solicitado, instale o GitHub App e conceda acesso ao repositório ([Conectar o GitHub](/pt/setup/connecting-github))
  </Step>

  <Step title="Edite e visualize páginas com a CLI">
    Use a CLI do Jamdesk para visualizar as edições das páginas antes de enviá-las ao GitHub.

    <Tabs>
      <Tab title="npm">
        ```bash
        npm install -g jamdesk
        cd your-docs
        jamdesk dev
        ```
      </Tab>
      <Tab title="npx">
        ```bash
        cd your-docs
        npx jamdesk dev
        ```
      </Tab>
    </Tabs>

    A visualização local é executada em **http://localhost:3000**. Saiba mais em [Visualização local](/pt/development/local-preview).

    Abra uma página `.mdx` no editor, salve uma alteração e atualize a visualização local. Quando tudo estiver correto, publique-a usando o fluxo do Git na próxima etapa.
  </Step>

  <Step title="Faça deploy enviando alterações ao GitHub">
    Cada envio para a branch configurada aciona um build e publica o conteúdo no seu subdomínio do Jamdesk.

    ```bash
    git add .
    git commit -m "Add docs content"
    git push origin main
    ```

    Substitua `main` pela branch configurada no projeto se você usar uma branch diferente.

    Quando o build for concluído, sua documentação estará disponível em `your-project.jamdesk.app`. Consulte [Deploy](/pt/development/deployment) para obter detalhes.
  </Step>

  <Step title="Opcional: adicione um domínio personalizado">
    Disponibilize sua documentação no seu próprio domínio em vez do subdomínio do Jamdesk.

    1. Acesse **Settings** → **Domains** no dashboard do Jamdesk
    2. Adicione seu domínio (por exemplo, `docs.example.com`)
    3. Crie os registros DNS exibidos no dashboard
    4. Aguarde a conclusão da verificação e do SSL

    Para solucionar problemas, consulte [Domínios personalizados](/pt/deploy/custom-domains).
  </Step>
</Steps>

## Valide o fluxo de ponta a ponta

- Seu subdomínio do Jamdesk é carregado e mostra o build mais recente
- A visualização local exibe o mesmo conteúdo e a mesma navegação
- Se configurado, o domínio personalizado é verificado e disponibiliza HTTPS
- O histórico de builds mostra o commit mais recente e a atribuição do autor

## Opcional: hospede em /docs

Se quiser disponibilizar a documentação em um subcaminho como `example.com/docs`, consulte [Visão geral do deploy](/pt/deploy/overview) e [Hospedagem em subcaminho](/pt/deploy/subpath-hosting).

## O que vem a seguir?

<Columns cols={2}>
  <Card title="Crie um projeto" icon="plus" href="/pt/setup/creating-projects">
    Gerencie configurações e modelos do projeto
  </Card>
  <Card title="Visão geral da CLI" icon="terminal" href="/pt/cli/overview">
    Instale a CLI e veja os comandos disponíveis
  </Card>
  <Card title="Visão geral do deploy" icon="cloud-arrow-up" href="/pt/deploy/overview">
    Compare as opções de hospedagem
  </Card>
  <Card title="Domínios personalizados" icon="globe" href="/pt/deploy/custom-domains">
    Verifique o DNS e solucione problemas de configuração
  </Card>
</Columns>