Criar um projeto
Crie um projeto Jamdesk a partir de um modelo ou conecte um repositório GitHub existente. Seu site fica online em yourproject.jamdesk.app em poucos minutos.
Você precisa de um projeto antes de escrever qualquer documentação. Comece a partir de um modelo para que o Jamdesk crie o repositório no GitHub ou no Bitbucket Cloud. Ou conecte um repositório existente que já tenha um docs.json. Seu site fica online em alguns minutos. Para começar sem uma conta no GitHub, veja Documentação sem GitHub.
Criar um novo projeto
Acesse dashboard.jamdesk.com e entre com sua conta do GitHub.
O Jamdesk pede que você autorize o GitHub App do Jamdesk no primeiro login.
No painel, clique em New Project no canto superior direito.
Comece com um modelo pré-criado. O Jamdesk cria um novo repositório no GitHub 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.
Defina as informações básicas do seu projeto:
| Campo | Descrição |
|---|---|
| Name | Nome de exibição mostrado no painel |
| Slug | Identificador amigável para URL (ex.: my-docs) |
| Domain | Seu subdomínio *.jamdesk.app |
Estrutura mínima do repositório
Um projeto Jamdesk precisa apenas de um docs.json e de pelo menos uma página:
my-docs/
├── docs.json
└── introduction.mdx
Exemplo 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
Configure seu projeto em Settings:
General
- Name: atualize o nome de exibição
- Slug: altere o identificador do projeto
- Delete Project: remove o projeto permanentemente
Repository
- Branch: qual branch dispara os deploys
- Docs Path: localização do
docs.jsonpara monorepos
Domain
- Subdomain: sua URL
*.jamdesk.app - Custom Domain: adicione seu próprio domínio
- Host at a subpath: sirva a documentação em um caminho como
/docsou/helpem vez da raiz do site
Build
- Show Jamdesk Branding: exibe o link "Powered by Jamdesk" no rodapé (ativado por padrão)
- Rebuild: dispara manualmente um novo build
As alterações nas configurações de build exigem um novo build para terem efeito.
Limites do projeto
O plano Pro inclui um projeto. Adicione mais com complementos de projeto por US$ 15/mês cada.
