Jamdesk Documentation logo

Visualização local

Visualize sua documentação na sua máquina com a CLI do Jamdesk antes de publicar em produção. As alterações aparecem conforme você edita os arquivos.

Execute jamdesk dev (ou npx jamdesk dev) em um diretório que contenha um docs.json. Isso inicia um servidor local com recarregamento automático e busca. Os componentes são renderizados como em produção.

Pré-requisitos

  • Node.js 22.18+ ou 24.11+ - 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 depois execute a partir do seu diretório de 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

Recarregamento automático

Edite arquivos MDX e veja as alterações instantaneamente. Edições no docs.json e no seu style.css aparecem ao atualizar a página.

Busca completa

Teste a busca Cmd+K com o seu conteúdo

Todos os componentes

Os componentes são renderizados como em produção

Troca de tema

Alterne o tema de cores

Porta personalizada

A porta padrão é 3000. Passe outra com --port:

jamdesk dev --port 3001

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

{
  "defaultPort": 3001
}

Modo detalhado

Mostre os detalhes do build com a flag --verbose:

jamdesk dev --verbose

Isso mostra:

  • Detecção de alterações de arquivos
  • Tempo de build
  • Análise da navegação
  • Quaisquer avisos ou erros

Desempenho na primeira execução

A primeira execução de jamdesk dev instala as dependências em ~/.jamdesk. Isso leva de 30 a 60 segundos. As execuções seguintes começam em menos de 5 segundos.

Limpe o cache e force uma nova instalação:

jamdesk clean
jamdesk dev

Solução de problemas

Outro processo está usando a porta 3000.

Opção 1: Use uma porta diferente

jamdesk dev --port 3001

Opção 2: Encontre e encerre o processo

lsof -i :3000
kill -9 <PID>

Execute o comando a partir do diretório que contém o seu arquivo docs.json:

ls docs.json  # Should show the file
jamdesk dev
  1. Verifique o terminal para erros
  2. Force a atualização do navegador (Cmd+Shift+R)
  3. Reinicie o servidor de desenvolvimento
  4. Execute jamdesk clean e tente novamente

Execute o diagnóstico:

jamdesk doctor

Ele verifica o seu ambiente e informa os problemas encontrados.

Qual é o próximo passo?

Extensão do VS Code

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

Deployment

Saiba mais sobre o processo de build e deploy