Jamdesk Documentation logo

CSS personalizado

Adicione CSS personalizado para sobrescrever estilos do tema, ajustar a tipografia ou aplicar estilos da sua marca. O Jamdesk expõe variáveis CSS para as personalizações mais comuns.

Adicione CSS personalizado sobre os padrões do tema para combinar com a sua marca ou ajustar estilos específicos.

Adicionar CSS personalizado

Crie um arquivo style.css na raiz do seu projeto (na mesma pasta do seu docs.json). O Jamdesk o aplica a todas as páginas. Não é necessária nenhuma entrada no docs.json.

Qualquer arquivo .css na raiz do projeto funciona, não apenas style.css. O Jamdesk combina vários arquivos na ordem alfabética dos nomes.

Execute jamdesk dev para visualizar o resultado localmente. Ele renderiza o seu CSS personalizado da mesma forma que o site publicado.

style.css
/* Your custom styles */
article h1 {
  font-size: 2.5rem;
}

Exemplos de CSS e JS mostra como trocar as cores do cabeçalho e adicionar um botão flutuante.

Variáveis CSS

As cores e os raios de borda vêm de variáveis CSS. Sobrescreva-as em :root. Todos os componentes que as usam acompanham a mudança:

style.css
:root {
  /* Page and text colors */
  --color-bg-primary: #ffffff;      /* page background */
  --color-bg-secondary: #f8fafc;    /* inputs, subtle panels */
  --color-text-primary: #0a0a0a;    /* headings */
  --color-text-secondary: #404144;  /* body text */
  --color-text-muted: #737373;      /* captions and hints */
  --color-border: #e2e8f0;

  /* Corner radius for cards, buttons and panels */
  --radius-sm: 6px;
  --radius-md: 8px;
  --radius-lg: 12px;
}

Os valores acima são os padrões do tema Jam. Outros temas partem dos próprios valores. Você pode lê-los em qualquer um deles nas ferramentas de desenvolvedor do navegador, no elemento <html>.

As cores da sua marca pertencem ao docs.json, não aqui. O Jamdesk transforma colors.primary no destaque usado em links, botões e no item ativo da barra lateral. Veja Cores personalizadas.

As fontes também pertencem ao docs.json. O campo fonts carrega uma Google Font ou o seu próprio arquivo de fonte e a aplica em todo o site. Definir font-family em CSS só funciona com !important. Os temas definem fontes com seletores mais específicos. Veja Tipografia.

Personalizações comuns

Alterar a fonte do código

Blocos de código mantêm a fonte monoespaçada do tema, a menos que você a sobrescreva com !important:

@import url('https://fonts.googleapis.com/css2?family=Fira+Code&display=swap');

article pre,
article pre code,
article code {
  font-family: 'Fira Code', monospace !important;
  font-variant-ligatures: common-ligatures;
}

Os links dentro do corpo da página sempre têm classes. Selecione-os pela posição em que estão, e não com a:not([class]):

article .prose a {
  text-decoration: underline;
  text-underline-offset: 3px;
}

article .prose a:hover {
  text-decoration-thickness: 2px;
}

Ajustar o espaçamento dos títulos

article .prose h2 {
  margin-top: 3rem;
  margin-bottom: 1rem;
}

article .prose h3 {
  margin-top: 2rem;
  margin-bottom: 0.75rem;
}

Estilizar blocos de aviso

Os callouts obtêm as cores de variáveis que terminam em -bg, -border e -text:

CalloutPrefixo da variável
<Note>--color-note-
<Info>--color-info-
<Warning>--color-warning-
<Tip>, <Check>--color-success-
<Danger>--color-error-
/* Warmer Note callouts */
:root {
  --color-note-bg: #fef3c7;
  --color-note-border: #f59e0b;
}

Estilizar a aba ativa

article [role="tab"][aria-selected="true"] {
  border-bottom-width: 3px;
}

Modo escuro

O Jamdesk adiciona a classe dark a <html> no modo escuro. Coloque as sobrescritas do modo escuro em html.dark:

/* Light mode */
:root {
  --color-bg-primary: #fffdf7;
}

.custom-banner {
  background: #f0f4ff;
  color: #1e3a5f;
}

/* Dark mode */
html.dark {
  --color-bg-primary: #14110f;
}

html.dark .custom-banner {
  background: #1e293b;
  color: #e2e8f0;
}

[data-theme="dark"] nunca corresponde a nada. O data-theme em <body> contém o nome do seu tema (jam, nebula e assim por diante), não light ou dark.

Seletores a usar

Os nomes de classe do Jamdesk vêm do Tailwind e podem mudar em qualquer versão. Estes ganchos são estáveis:

SeletorCorresponde a
html.darkA página enquanto o modo escuro está ativo
body[data-theme="jam"]O tema ativo, pelo nome
header[data-has-tabs]O cabeçalho do site
articleA página atual, incluindo o título
article .proseO conteúdo do corpo da página
#content-scroll-containerA coluna de conteúdo da página
[role="tab"][aria-selected="true"]A aba selecionada em um grupo <Tabs>

O banner que você define no docs.json tem seus próprios ganchos estáveis:

GanchoCorresponde a
.jd-bannerA barra do banner
[data-type="info"], [data-type="warning"], [data-type="danger"]O type da barra, como atributo em .jd-banner
.jd-banner-innerA linha centralizada dentro da barra
.jd-banner-iconO ícone dos banners warning e danger
.jd-banner-contentO texto do banner
.jd-banner-closeO botão de fechar de um banner que pode ser fechado
--jd-banner-bgA cor de fundo da barra
--jd-banner-fgA cor do texto e do ícone da barra
--jd-banner-heightA altura medida da barra, definida em <html>

Defina as variáveis de cor em .jd-banner, não em :root. Os tipos warning e danger definem os próprios valores na barra, então um valor em :root nunca chega a eles.

Uma regra .jd-banner simples muda o estilo de todos os tipos:

style.css
.jd-banner {
  --jd-banner-bg: #111827;
  --jd-banner-fg: #f9fafb;
}

Adicione o atributo para mudar só um tipo:

style.css
.jd-banner[data-type="danger"] {
  --jd-banner-bg: #7f1d1d;
}

Se o seu CSS tem uma regra antiga como [data-jd-banner] { background: ... }, ela muda a cor de todos os tipos, inclusive warning e danger. Troque-a por uma das regras acima.

Use --jd-banner-height para manter seus próprios elementos fixos abaixo da barra. A variável não é definida quando nenhum banner aparece, então dê a ela um valor alternativo de 0px:

style.css
.my-sticky-toolbar {
  position: sticky;
  top: var(--jd-banner-height, 0px);
}

Fontes externas

Carregue fontes pelo docs.json sempre que possível. O campo fonts carrega Google Fonts e arquivos hospedados por você, incluindo arquivos .woff2 no seu repositório. Ele as aplica a títulos e ao texto do corpo.

O CSS é o plano B para tudo o que o fonts não cobre, como a fonte de código acima ou uma fonte diferente em um único elemento. Carregue a fonte com @import ou @font-face e depois defina-a com !important:

@font-face {
  font-family: 'CustomFont';
  src: url('/fonts/custom-font.woff2') format('woff2');
  font-weight: 400;
  font-display: swap;
}

article .prose blockquote {
  font-family: 'CustomFont', serif !important;
}

Estilos responsivos

Use media queries para ajustes de tamanho de tela:

/* Phones */
@media (max-width: 768px) {
  article h1 {
    font-size: 1.75rem;
  }
}

Depuração

Clique com o botão direito em um elemento e escolha Inspect para descobrir o que segmentar. Prefira os ganchos em Seletores para usar, papéis como role="tab" e variáveis CSS em vez de nomes de classe longos do Tailwind. Se uma regra não se aplicar, verifique o painel Styles em busca de uma regra do tema que vença por especificidade ou use !important.

Limitações

  • O CSS se aplica globalmente. Use seletores específicos para evitar conflitos
  • Alguns estilos do tema, incluindo fontes e o fundo do cabeçalho Jam, usam !important ou seletores muito específicos. Talvez você precise de !important para sobrescrevê-los
  • A visualização local (jamdesk dev) aplica as edições do seu arquivo CSS ao atualizar o navegador. O site publicado recebe as mudanças no próximo build

Próximos passos

Temas

Escolha e configure temas

Exemplos de CSS e JS

Um cabeçalho personalizado e um botão flutuante Ask AI