Theming

Customize the look and feel of your documentation

Jamdesk comes with three professionally designed themes. Each brings a distinct personality to your docs while maintaining readability and accessibility.

Choosing a Theme

Set your theme in docs.json:

{
  "theme": "jam"
}

Available Themes

The default theme. Clean, modern, and professional.

Characteristics:

  • Inter font family
  • Subtle shadows and borders
  • Balanced whitespace
  • Great for most documentation
{
  "theme": "jam"
}

Airy and relaxed with a developer-friendly feel.

Characteristics:

  • Monospace body text option
  • Softer color palette
  • More breathing room
  • Great for technical docs and API references
{
  "theme": "nebula"
}

Sharp and high-contrast for dense technical content.

Characteristics:

  • Strong typography hierarchy
  • High contrast ratios
  • Compact spacing
  • Great for reference documentation
{
  "theme": "pulsar"
}

Custom Colors

Override the default palette to match your brand:

{
  "theme": "jam",
  "colors": {
    "primary": "#635BFF",
    "light": "#7C75FF",
    "dark": "#4F46E5"
  }
}
ColorUsage
primaryLinks, buttons, accents
lightHover states, highlights
darkActive states, dark mode accents

Use a color tool like Coolors or Realtime Colors to generate a harmonious palette.

Dark Mode

All themes include automatic dark mode. Jamdesk respects the user's system preference and provides a toggle in the navbar.

Testing Dark Mode

In your browser's developer tools:

  1. Open the Elements panel
  2. Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows)
  3. Search for "Emulate CSS prefers-color-scheme: dark"

Or use the theme toggle in your docs navbar.

Dark Mode Colors

Your color palette automatically adapts to dark mode. The light color often becomes more prominent in dark mode for better contrast.

Typography

Themes include carefully selected font stacks:

ThemeHeadingsBody
JamInterInter
NebulaInterSystem monospace
PulsarInterInter

Custom Fonts

Custom font support is coming soon. For now, themes use system fonts that load instantly.

What's Next?

Was this page helpful?