Tutorial de ponta a ponta
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.
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)
- Node.js 20+ se quiser instalar a CLI com npm
Crie seu primeiro projeto no dashboard do Jamdesk e conecte um repositório.
- Siga Criar projetos 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)
Use a CLI do Jamdesk para visualizar as edições das páginas antes de enviá-las ao GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devA visualização local é executada em http://localhost:3000. Saiba mais em Visualização local.
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.
Cada envio para a branch configurada aciona um build e publica o conteúdo no seu subdomínio do Jamdesk.
git add .
git commit -m "Add docs content"
git push origin mainSubstitua 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 para obter detalhes.
Disponibilize sua documentação no 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 exibidos no dashboard
- Aguarde a conclusão da verificação e do SSL
Para solucionar problemas, consulte Domínios personalizados.
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 e Hospedagem em subcaminho.