Identidade visual
Configure logos, favicons, links da barra de navegação e conteúdo do rodapé do seu site de documentação. Suporta variantes para modo claro e escuro, cores personalizadas e ícones para links externos.
A identidade visual controla o que os leitores veem primeiro: logos, favicons e links de navegação. Cada um aceita variantes para o modo claro e para o modo escuro.
Logotipo
Adicione seu logo ao cabeçalho de navegação:
{
"logo": {
"light": "/images/logo-light.webp",
"dark": "/images/logo-dark.webp",
"href": "https://yourcompany.com"
}
}
| Campo | Descrição |
|---|---|
light | Logo para o modo claro (logo escuro sobre fundo claro) |
dark | Logo para o modo escuro (logo claro sobre fundo escuro) |
href | Para onde o clique no logo leva |
Use logos em SVG para uma renderização nítida em qualquer tamanho. Use o mesmo logo para light e dark se você tiver apenas um. As pré-visualizações de links não conseguem mostrar texto dentro de um logo SVG. Converta qualquer texto em contornos (paths). Veja Personalize o cartão social.
Dimensões do logotipo
Os logos são exibidos com largura máxima de 120px. Para melhores resultados:
- Largura: 120-240px
- Altura: 30-40px
- Formato: SVG preferencialmente
Favicon
Uma imagem para os dois modos:
{
"favicon": "/images/favicon.svg"
}
Ou uma variante separada para cada modo:
{
"favicon": {
"light": "/images/favicon.svg",
"dark": "/images/favicon-dark.svg"
}
}
dark é opcional. Sem ele, light é exibido em todos os modos. A Jamdesk emite um <link rel="icon"> para o favicon principal, além de um segundo link com media="(prefers-color-scheme: dark)" para a variante escura.
Formatos suportados: SVG, PNG, ICO.
Um SVG que usa currentColor para seus traços e preenchimentos se adapta ao modo sozinho. O navegador substitui pela cor de primeiro plano ativa.
Nome do site
O campo name aparece nas abas do navegador e nos resultados de busca:
{
"name": "Acme Docs",
"description": "Documentation for the Acme API"
}
Altere o formato do título, ou deixe o nome de fora dele, com seo.titleTemplate.
Combine-o com uma description. Sem ela, os resultados de busca e as pré-visualizações de links mostram um texto genérico de substituição.
Descrição
O campo description é o resumo SEO padrão do seu site. Os mecanismos de busca o exibem abaixo do título do site, e as plataformas sociais o usam nas pré-visualizações de links:
{
"description": "Build, ship, and scale documentation with the Acme platform."
}
Procure entre 50 e 160 caracteres, escritos para um leitor que está decidindo se vai clicar. Páginas com description próprio no frontmatter usam esse valor. As demais páginas usam a descrição do site.
Links de navegação
Adicione links à sua barra de navegação:
{
"navbar": {
"links": [
{ "label": "Blog", "href": "https://yourcompany.com/blog" },
{ "label": "Pricing", "href": "https://yourcompany.com/pricing" }
],
"primary": {
"type": "button",
"label": "Get Started",
"href": "https://app.yourcompany.com/signup"
}
}
}
Opções de link
| Campo | Tipo | Descrição |
|---|---|---|
label | string | Texto exibido |
href | string | URL (externa ou interna) |
Botão principal
O campo primary cria um botão de chamada à ação em destaque:
{
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://app.yourcompany.com"
}
}
Os links e o botão principal ficam no cabeçalho em tablets e desktops. Em celulares não há espaço para eles no cabeçalho. Eles aparecem no menu, com o botão principal fixado na parte inferior. O Pulsar não exibe os links da barra de navegação nem o botão principal.
Rodapé
O rodapé fica na parte inferior de todas as páginas. Ele pode conter ícones de redes sociais, colunas de links e uma linha de direitos autorais. Cada idioma pode ter seu próprio rodapé, e você pode reestilizá-lo com CSS personalizado.
Links sociais
Exiba ícones de redes sociais na parte inferior de todas as páginas:
{
"footer": {
"socials": {
"github": "https://github.com/yourcompany",
"x": "https://x.com/yourcompany",
"discord": "https://discord.gg/yourserver",
"linkedin": "https://linkedin.com/company/yourcompany"
}
}
}
Plataformas compatíveis
| Plataforma | Chave | Descrição |
|---|---|---|
| GitHub | github | Link para sua organização ou repositório no GitHub |
| X (Twitter) | x ou twitter | Link para seu perfil no X/Twitter |
linkedin | Link para a página da empresa no LinkedIn | |
| Discord | discord | Link para o seu servidor no Discord |
| Slack | slack | Link para sua comunidade no Slack |
| YouTube | youtube | Link para o seu canal no YouTube |
instagram | Link para o seu perfil no Instagram | |
facebook | Link para a sua página no Facebook | |
reddit | Link para o seu subreddit | |
| Telegram | telegram | Link para o seu canal no Telegram |
| Bluesky | bluesky | Link para o seu perfil no Bluesky |
| Threads | threads | Link para o seu perfil no Threads |
| Medium | medium | Link para a sua publicação no Medium |
| Hacker News | hacker-news | Link para o seu perfil no Hacker News |
| Website | website | Link para o seu site principal |
Os ícones são exibidos em uma ordem fixa, independentemente da ordem usada na sua configuração. GitHub e X/Twitter vêm primeiro.
Colunas de links
Adicione grupos de links acima dos seus ícones sociais:
{
"footer": {
"links": [
{
"header": "Resources",
"items": [
{ "label": "Blog", "href": "https://yourcompany.com/blog" },
{ "label": "Changelog", "href": "/changelog" }
]
},
{
"header": "Company",
"items": [
{ "label": "About", "href": "https://yourcompany.com/about" },
{ "label": "Careers", "href": "https://yourcompany.com/careers" }
]
}
],
"socials": {
"github": "https://github.com/yourcompany",
"x": "https://x.com/yourcompany"
}
}
}
| Campo | Tipo | Descrição |
|---|---|---|
links | array | Array de objetos de coluna de links |
links[].header | string | Título da coluna (opcional) |
links[].items | array | Links na coluna |
links[].items[].label | string | Texto exibido para o link |
links[].items[].href | string | URL (caminhos internos ou URLs externas) |
Links externos (que começam com http) abrem em uma nova aba. Links internos navegam dentro da sua documentação.
Linha de direitos autorais
Adicione copyright e ele aparece na linha inferior do rodapé, ao lado do link "Powered by Jamdesk":
{
"footer": {
"copyright": "© 2026 Acme Inc. All rights reserved."
}
}
É texto simples. Markdown e HTML são exibidos exatamente como digitados, então coloque links em uma coluna de links. Quebras de linha viram espaços, e o limite é de 200 caracteres. Digite o caractere © diretamente, pois © aparece literalmente.
Rodapé diferente por idioma
Em um site com mais de um idioma, qualquer entrada de navigation.languages pode ter seu próprio footer. Ele aceita os mesmos campos do rodapé do nível superior:
{
"footer": {
"copyright": "© 2026 Acme Inc."
},
"navigation": {
"languages": [
{
"language": "en",
"groups": [...]
},
{
"language": "fr",
"groups": [...],
"footer": {
"links": [
{
"header": "Entreprise",
"items": [{ "label": "À propos", "href": "https://acme.com/fr/about" }]
}
],
"copyright": "© 2026 Acme Inc. Tous droits réservés."
}
}
]
}
}
O rodapé de um idioma substitui o do nível superior. Nada é mesclado, então copie qualquer coisa que queira manter. Idiomas sem footer próprio usam o do nível superior. Veja Idiomas para saber como ocultar o rodapé de um idioma específico.
Estilize o rodapé
O rodapé tem nomes de classe que permanecem os mesmos entre versões, então o CSS personalizado direcionado a eles continua funcionando. Por exemplo, isto deixa os títulos das colunas em maiúsculas e pinta o ícone do GitHub de roxo:
.jd-footer-column-title {
text-transform: uppercase;
letter-spacing: 0.05em;
}
.jd-footer-social[data-platform="github"] {
color: #6e40c9;
}A lista completa está em CSS personalizado.
Ocultar o rodapé em páginas específicas
Use o frontmatter para ocultar o rodapé em páginas individuais:
---
title: Landing Page
hideFooter: true
---
Use isso em páginas de destino personalizadas ou onde o rodapé atrapalhe.
Identidade visual do Jamdesk
Por padrão, um link "Powered by Jamdesk" aparece no rodapé das suas páginas de documentação. Você pode removê-lo.
Ocultar a identidade visual
Para remover a identidade da Jamdesk:
- Acesse Settings no seu painel da Jamdesk
- Encontre a seção Build Settings
- Desative Show Jamdesk Branding
- Dispare um novo build
A opção de identidade está disponível em todos os planos. As alterações entram em vigor após um novo build.
Exemplo completo de identidade visual
Uma configuração completa de identidade visual:
{
"name": "Acme Documentation",
"description": "Build amazing products with Acme",
"theme": "jam",
"colors": {
"primary": "#6366F1",
"light": "#818CF8",
"dark": "#4F46E5"
},
"favicon": "/images/favicon.svg",
"logo": {
"light": "/images/logo-dark.webp",
"dark": "/images/logo-light.webp",
"href": "https://acme.com"
},
"navbar": {
"links": [
{ "label": "API", "href": "/api/overview" },
{ "label": "Blog", "href": "https://acme.com/blog" }
],
"primary": {
"type": "button",
"label": "Sign Up",
"href": "https://app.acme.com/signup"
}
},
"footer": {
"socials": {
"github": "https://github.com/acme",
"x": "https://x.com/acme",
"discord": "https://discord.gg/acme"
},
"links": [
{
"header": "Resources",
"items": [
{ "label": "Blog", "href": "https://acme.com/blog" },
{ "label": "Status", "href": "https://status.acme.com" }
]
}
]
}
}
Domínio personalizado
Adicione seu domínio no painel da Jamdesk:
- Acesse Settings → Domains
- Adicione seu domínio (por exemplo,
docs.yourcompany.com) - Configure o DNS conforme indicado
- Aguarde a verificação
Sua documentação passa a carregar no seu domínio personalizado, com SSL automático.
