Criar um projeto
Crie um projeto Jamdesk a partir de um template ou conecte um repositório GitHub existente. Seu site ficará online em minutos.
Antes de escrever qualquer documentação, você precisa de um projeto. Você pode começar com um template (o Jamdesk cria o repositório para você no GitHub ou no Bitbucket Cloud) ou conectar um repositório existente que já tenha um docs.json. De qualquer forma, seu site estará online em poucos minutos.
Criar um novo projeto
Acesse dashboard.jamdesk.com e inicie sessão com sua conta do GitHub.
Usuários de primeira viagem receberão uma solicitação para autorizar o aplicativo do 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 do 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 e pronto.
Defina as informações básicas do seu projeto:
| Campo | Descrição |
|---|---|
| Name | Nome exibido no dashboard |
| Slug | Identificador compatível com URL (por exemplo, my-docs) |
| Domain | Seu subdomínio *.jamdesk.app |
Estrutura mínima do repositório
Um projeto 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 exibido
- Slug - Altere o identificador do projeto
- Delete Project - Remova o projeto permanentemente
Repository
- Branch - A branch que aciona os deploys
- Docs Path - Localização de
docs.jsonem 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 - Acione manualmente um novo build
Alterações nas configurações de build exigem um novo build para entrarem em vigor.
Limites do projeto
| Plano | Projetos | Builds/mês |
|---|---|---|
| Gratuito | 1 | 100 |
| Pro | 10 | Ilimitados |
| Team | Ilimitados | Ilimitados |