Jamdesk Documentation logo

Visualização local

A CLI do Jamdesk permite visualizar a documentação na sua máquina antes de enviá-la para produção. As alterações aparecem instantaneamente durante a edição.

Execute jamdesk dev (ou npx jamdesk dev) em qualquer diretório que contenha um docs.json para iniciar um servidor local com atualização automática, pesquisa completa e todos os componentes funcionando exatamente como em produção.

Pré-requisitos

Antes de começar, verifique se você tem:

  • Node.js 20 ou superior — verifique com node --version
  • Um projeto de documentação — com um arquivo de configuração docs.json

Iniciando o servidor de desenvolvimento

Instale a CLI globalmente e execute-a no diretório da documentação:

npm install -g jamdesk
cd your-docs
jamdesk dev

Sua documentação estará disponível em http://localhost:3000

O que você obtém

Atualização automática

Edite arquivos MDX e veja as alterações instantaneamente. As edições em docs.json e no seu style.css são aplicadas após a atualização.

Pesquisa completa

Teste a pesquisa Cmd+K com seu conteúdo real

Todos os componentes

Todos os componentes funcionam exatamente como em produção

Alternância de tema

Teste os modos claro e escuro

Porta personalizada

A porta padrão é 3000. Se ela estiver em uso, especifique outra:

jamdesk dev --port 3001

Ou defina um padrão permanente em ~/.jamdeskrc:

{
  "defaultPort": 3001
}

Modo detalhado

Veja informações detalhadas do build com a flag --verbose:

jamdesk dev --verbose

Isso mostra:

  • Detecção de alterações nos arquivos
  • Duração do build
  • Análise da navegação
  • Avisos ou erros

Desempenho na primeira execução

Na primeira vez que você executar jamdesk dev, as dependências serão instaladas em ~/.jamdesk. Isso leva de 30 a 60 segundos. As execuções seguintes começam em menos de 5 segundos.

Para limpar o cache e forçar uma nova instalação:

jamdesk clean
jamdesk dev

Solução de problemas

Outro processo está usando a porta 3000.

Opção 1: Use outra porta

jamdesk dev --port 3001

Opção 2: Encontre e interrompa o processo

lsof -i :3000
kill -9 <PID>

Verifique se você está no diretório que contém seu arquivo docs.json:

ls docs.json  # Should show the file
jamdesk dev

Tente estas etapas:

  1. Verifique se há erros no terminal
  2. Atualize o navegador forçadamente (Cmd+Shift+R)
  3. Reinicie o servidor de desenvolvimento
  4. Execute jamdesk clean e tente novamente

Execute o diagnóstico:

jamdesk doctor

Isso verifica seu ambiente e identifica problemas.

Qual é o próximo passo?

Extensão do VS Code

Inicie o servidor de desenvolvimento na barra de status do VS Code

Implantação

Saiba mais sobre o processo de build e implantação