Tutorial completo
Do repositório vazio a um site de documentação no ar: crie um projeto, visualize localmente, faça o deploy e, opcionalmente, configure um domínio personalizado.
Vá de um repositório vazio a um site de documentação no ar. Pule qualquer etapa que você já tenha concluído.
Pré-requisitos
- Uma conta no GitHub
- Um repositório com conteúdo de documentação (ou use o Starter Template)
- Node.js 22.18+ ou 24.11+ caso queira instalar a CLI com npm
Crie um projeto no dashboard do Jamdesk e conecte um repositório.
- Siga Criando projetos para definir o nome do projeto, o slug e o caminho da documentação
- Se for solicitado, instale o GitHub App e conceda acesso ao repositório (Conectando o GitHub)
Visualize as edições das páginas com a CLI do Jamdesk antes de enviá-las ao GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devSua visualização local fica disponível em http://localhost:3000. Saiba mais em Visualização local.
Abra uma página .mdx no seu editor. Salve uma alteração e atualize a visualização local. Publique-a com o fluxo do Git na próxima etapa.
Cada push para a branch configurada dispara um build. O build é publicado no seu subdomínio do Jamdesk.
git add .
git commit -m "Add docs content"
git push origin mainSubstitua main pela branch configurada no seu projeto.
Sua documentação entra no ar em your-project.jamdesk.app quando o build terminar. Veja Deploy para mais detalhes.
Sirva sua documentação a partir do seu próprio domínio, em vez do subdomínio do Jamdesk.
- Acesse Settings → Domains no dashboard do Jamdesk
- Adicione seu domínio (por exemplo,
docs.example.com) - Crie os registros DNS mostrados no dashboard
- Aguarde a verificação e a conclusão do SSL
Para solução de problemas, veja Domínios personalizados.
Valide o fluxo de ponta a ponta
- Seu subdomínio do Jamdesk carrega e mostra o build mais recente
- A visualização local reflete o mesmo conteúdo e a mesma navegação
- Se configurado, o domínio personalizado está verificado e servindo HTTPS
- O histórico de builds mostra o commit mais recente e a autoria
Opcional: hospede em /docs
Para servir a documentação em um subcaminho como example.com/docs, veja Visão geral de deploy e Hospedagem em subcaminho.
