Branding

Make your documentation feel like a natural extension of your product with custom branding.

Logo

Add your logo to the navigation header:

{
  "logo": {
    "light": "/images/logo-light.svg",
    "dark": "/images/logo-dark.svg",
    "href": "https://yourcompany.com"
  }
}

Field	Description
`light`	Logo for light mode (dark logo on light background)
`dark`	Logo for dark mode (light logo on dark background)
`href`	Where clicking the logo navigates

Use SVG logos for crisp rendering at any size. If you only have one logo, use it for both light and dark.

Logo Dimensions

Logos are displayed at 120px width maximum. For best results:

Width: 120-240px
Height: 30-40px
Format: SVG preferred

Favicon

Add a browser tab icon:

{
  "favicon": "/images/favicon.svg"
}

Supported formats: SVG, PNG, ICO

SVG favicons support dark mode! The browser will use your system colors if you use currentColor in the SVG.

Site Name

The name field appears in browser tabs and search results:

{
  "name": "Acme Docs",
  "description": "Documentation for the Acme API"
}

Add links to your navbar:

{
  "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"
    }
  }
}

Link Options

Field	Type	Description
`label`	string	Display text
`href`	string	URL (external or internal)

Primary Button

The primary field creates a highlighted call-to-action button:

{
  "primary": {
    "type": "button",
    "label": "Dashboard",
    "href": "https://app.yourcompany.com"
  }
}

Footer

Add social links to your footer:

{
  "footer": {
    "socials": {
      "twitter": "https://twitter.com/yourcompany",
      "github": "https://github.com/yourcompany",
      "discord": "https://discord.gg/yourserver"
    }
  }
}

Supported social platforms:

twitter / x
github
discord
linkedin
youtube
slack

Full Branding Example

Here's a complete branding configuration:

{
  "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.svg",
    "dark": "/images/logo-light.svg",
    "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": {
      "twitter": "https://twitter.com/acme",
      "github": "https://github.com/acme"
    }
  }
}

Custom Domain

Add your domain in the Jamdesk dashboard:

Go to Settings → Domains
Add your domain (e.g., docs.yourcompany.com)
Configure DNS as shown
Wait for verification

Your docs will be accessible at your custom domain with automatic SSL.

What's Next?

Theming

Choose a theme and customize colors

Navigation

Organize your sidebar structure