Criar um projeto
Crie um projeto do Jamdesk a partir de um template ou conecte um repositório GitHub existente e publique seu site em poucos minutos.
Antes de escrever qualquer documentação, você precisa de um projeto. É possível começar com um template (o Jamdesk cria o repositório GitHub para você) ou conectar um repositório existente que já tenha um docs.json. Em ambos os casos, você terá um site disponível em poucos minutos.
Criar um novo projeto
Acesse dashboard.jamdesk.com e faça login com sua conta do GitHub.
Usuários que acessarem pela primeira vez receberão uma solicitação para autorizar o aplicativo GitHub do Jamdesk.
No dashboard, clique em New Project no canto superior direito.
Comece com um template pré-configurado. O Jamdesk cria um novo repositório GitHub para você, com conteúdo de exemplo, navegação e componentes já configurados.
O Starter Template padrão inclui páginas de exemplo, uma especificação OpenAPI e exemplos de todos os componentes. Substitua o conteúdo pelo seu próprio e pronto.
Defina as informações básicas do seu projeto:
| Campo | Descrição |
|---|---|
| Name | Nome de exibição mostrado no dashboard |
| Slug | Identificador compatível com URLs (por exemplo, my-docs) |
| Domain | Seu subdomínio *.jamdesk.app |
Estrutura mínima do repositório
Um projeto do Jamdesk precisa apenas de um docs.json e pelo menos uma página:
my-docs/
├── docs.json
└── introduction.mdxExemplo de docs.json:
{
"$schema": "https://jamdesk.com/docs.json",
"name": "My Docs",
"theme": "jam",
"navigation": {
"groups": [
{
"group": "Getting Started",
"pages": ["introduction"]
}
]
}
}Configurações do projeto
Após a criação, configure seu projeto em Settings:
General
- Name - Atualize o nome de exibição
- Slug - Altere o identificador do projeto
- Delete Project - Remova o projeto permanentemente
Repository
- Branch - Branch que inicia as implantações
- Docs Path - Localização de
docs.jsonpara monorepos
Domain
- Subdomain - Sua URL
*.jamdesk.app - Custom Domain - Adicione seu próprio domínio
- Host at a subpath - Disponibilize a documentação em um caminho como
/docsou/help, em vez da raiz do site
Build
- Show Jamdesk Branding - Exiba o link "Powered by Jamdesk" no rodapé (ativado por padrão)
- Rebuild - Inicie manualmente um novo build
As alterações nas configurações de build exigem um novo build para entrarem em vigor.
Limites do projeto
| Plano | Projetos | Builds/mês |
|---|---|---|
| Free | 1 | 100 |
| Pro | 10 | Ilimitados |
| Team | Ilimitados | Ilimitados |