Jamdesk Documentation logo

Editor da web

Edite a documentação do Jamdesk no navegador, explore o repositório conectado, altere MDX com prévia ao vivo e faça commits no GitHub para iniciar um build.

Edite sua documentação no painel do Jamdesk, sem clonar o repositório nem abrir um terminal. Abra uma página e edite o MDX ao lado de uma prévia ao vivo. Faça commit das alterações na sua branch do GitHub. Cada commit inicia um build, assim como um git push.

As capturas de tela mostram a interface em inglês.

Esta é a versão no navegador da prévia local e da extensão do VS Code. Use-a para fazer uma edição rápida de qualquer lugar.

O editor web do Jamdesk: navegação entre páginas à esquerda, editor MDX no centro e prévia ao vivo à direita

Abrir o editor

Clique em Editor na barra lateral do painel. O editor abre no repositório conectado e na branch padrão do seu projeto.

O editor requer um repositório GitHub conectado e uma tela ampla (desktop). Janelas menores exibem o aviso "wider browser needed". Todos os proprietários de projetos e membros da equipe podem usá-lo, em qualquer plano.

A interface

PainelO que faz
Navigation (esquerda)As páginas e os grupos do seu site, lidos de docs.json. Filtre páginas, abra o editor de Configuration (docs.json) ou clique em Add page.
Editor (centro)Um editor de código MDX para o arquivo aberto, com realce de sintaxe e contagem de palavras.
Preview (direita)Uma renderização ao vivo da página, atualizada enquanto você digita. Alterne entre Desktop / Mobile e Light / Dark para conferir a aparência.

No canto superior esquerdo, aparece a branch que você está editando. Troque de branch usando o seletor de branches.

Editar uma página

Clique em uma página na navegação para abri-la. Edite o MDX no painel central. A prévia é atualizada enquanto você digita. Suas edições permanecem como um rascunho local no navegador até você fazer commit. Alterne entre páginas sem perder o trabalho. Nada chega ao GitHub até você fazer commit.

Adicionar uma página

Clique em Add page para criar uma página sem sair do editor:

  1. Escolha um modelo inicial.
  2. Insira um título. O Jamdesk deriva o nome do arquivo a partir dele.
  3. Escolha o grupo de navegação.

A nova página é aberta como rascunho. O Jamdesk grava o novo arquivo .mdx e a entrada de navegação em docs.json em um único commit.

Fazer commit das alterações

Faça commit das alterações pendentes no GitHub para publicá-las:

1
Abrir a caixa de diálogo de commit

Clique em Commit. A caixa de diálogo lista todos os arquivos alterados (uma página, docs.json ou vários arquivos).

2
Escrever uma mensagem

Digite uma mensagem de commit ou clique em Generate para que o Jamdesk crie uma com base no diff.

3
Fazer commit

O Jamdesk faz commit das alterações na branch atual e inicia um build. Acompanhe-o na página Builds do projeto.

Descarte as alterações não salvas da página atual com Revert. Isso restaura a versão já commitada.

Trabalhar com alterações externas

O editor sinaliza a branch quando outro push é recebido enquanto você edita. Ao fazer commit, cada arquivo alterado na origem é aberto em uma mesclagem de três vias. Concilie as duas versões ali. Suas edições locais nunca são descartadas.

Fazer commit pelo editor grava um commit real no repositório. Isso aciona o mesmo pipeline de build que um push feito na sua máquina. Se a documentação estiver em um subdiretório do repositório (configuração de monorepo), o editor lê e grava nesse local.

Requisitos

RequisitoDetalhes
GitHub conectadoO projeto precisa ter um repositório e uma branch conectados.
Navegador desktopUma tela ampla (cerca de 1400 px ou mais). O editor não está disponível em telas de dispositivos móveis.
AcessoQualquer proprietário ou membro do projeto. Aplicam-se os bloqueios de gravação habituais (por exemplo, uma assinatura vencida).

E depois?

Prévia local

Pré-visualize e edite localmente com a CLI

Como funciona a implantação

O que acontece depois do commit