Visão geral da configuração

Todo site Jamdesk começa da mesma forma: um projeto no dashboard, um repositório do GitHub por trás dele e um arquivo docs.json que descreve sua navegação. Esta seção aborda essa configuração inicial, além das decisões estruturais que vale a pena tomar desde o início. É muito mais fácil definir o layout das URLs, os idiomas e o controle de acesso antes de ter cinquenta páginas do que depois.

Migrando de outra plataforma? Vá direto para o Guia de migração. O Jamdesk pode automatizar a maior parte da conversão.

Do repositório ao site publicado

Crie um projeto

Comece com um modelo ou conecte um repositório existente do GitHub. Seu site ficará disponível em yourproject.jamdesk.app.

Conecte o GitHub

Instale o aplicativo do GitHub para que cada push faça o deploy automaticamente.

Organize o repositório

Um arquivo docs.json e páginas MDX. Esse é todo o contrato.

Configuração principal

Criar um projeto

De um modelo ou repositório existente a um site publicado

Conectar o GitHub

Instalação do aplicativo, acesso ao repositório e deploys automáticos a cada push

Estrutura de diretórios

Arquivos obrigatórios, diretórios de páginas, imagens e snippets

Guia de migração

Migre de outra plataforma de documentação, de forma automatizada ou manual

Suporte a monorepo

Mantenha a documentação junto do código quando ela não estiver na raiz do repositório

Suporte a vários idiomas

Disponibilize a documentação em vários idiomas com um seletor de idioma

Estrutura do site

Navegação

Abas, grupos e páginas que organizam sua documentação

Redirecionamentos

Redirecionamentos exatos e baseados em padrões para páginas movidas ou renomeadas

Privacidade e acesso

Controle de acesso

Totalmente público, protegido por senha, misto ou SSO. Compare as opções.

Proteção por senha

Bloqueie todo o site ou apenas algumas páginas com uma senha compartilhada

SAML ou OIDC por meio do seu provedor de identidade