Jamdesk Documentation logo

Visão geral da configuração

Crie um projeto, conecte o GitHub, organize seu repositório e defina quem pode ler sua documentação. Comece aqui se seu site ainda não estiver no ar.

Um site Jamdesk é um projeto no dashboard, um repositório GitHub por trás dele e um arquivo docs.json que descreve sua navegação. Esta seção cobre essa configuração. Defina cedo a estrutura das URLs, os idiomas e o controle de acesso. Essas decisões são mais difíceis de mudar quando você já tem cinquenta páginas.

Para migrar de outra plataforma, consulte o Guia de migração.

Do repositório ao site publicado

1
Criar um projeto

Comece a partir de um template ou conecte um repositório GitHub existente. Seu site entra no ar em yourproject.jamdesk.app.

2
Conectar o GitHub

Instale o GitHub App para que cada push seja implantado automaticamente.

3
Organizar o repositório

Adicione um arquivo docs.json e páginas MDX.

Configuração principal

Criar um projeto

De um template ou de um repositório existente até um site no ar

Conectar o GitHub

Instalação do app, 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 múltiplos idiomas

Sirva 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 o site inteiro ou algumas páginas com uma senha compartilhada

Single Sign-On (SSO)

SAML ou OIDC através do seu provedor de identidade