Logo与品牌

品牌设置控制读者最先看到的视觉元素：Logo、favicon 和导航链接。每一项都支持浅色/深色模式变体。

徽标

将 Logo 添加到导航栏顶部：

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

徽标尺寸

Logo 的最大显示宽度为 120px。为获得最佳效果：

• 宽度：120–240px
• 高度：30–40px
• 格式：推荐 SVG

网站图标

两种模式使用同一张图片：

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

或为每种模式分别指定一张图片：

{
  "favicon": {
    "light": "/images/favicon.svg",
    "dark": "/images/favicon-dark.svg"
  }
}

dark 为可选项。未设置时，所有模式均显示 light。Jamdesk 会为主 favicon 输出一个 <link rel="icon">，并为深色变体额外输出一个带 media="(prefers-color-scheme: dark)" 的 link。

支持的格式：SVG、PNG、ICO。

网站名称

name 字段会显示在浏览器标签页和搜索结果中：

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

如需更改标题格式，或不在标题中包含站点名称，请使用 seo.titleTemplate。

请同时配置 description。若未配置，搜索结果和链接预览将显示通用的备用内容。

描述

description 字段是站点默认的 SEO 摘要。搜索引擎会将其显示在站点标题下方，社交平台则用于链接预览：

{
  "description": "Build, ship, and scale documentation with the Acme platform."
}

建议长度为 50–160 个字符，面向决定是否点击的读者撰写。若页面自身设置了 description frontmatter，则使用页面自己的描述；其他页面则使用站点描述。

导航链接

在导航栏中添加链接：

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

链接选项

主要按钮

primary 字段用于创建一个突出显示的行动号召按钮：

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

在平板和桌面端，导航链接与主按钮位于页眉中。手机端页眉空间不足，它们会显示在菜单中，主按钮固定在菜单底部。Pulsar 不显示导航栏链接和主按钮。

页脚

页脚位于每个页面的底部，可包含社交图标、链接列和版权信息。每种语言可以拥有各自的页脚，并可通过自定义 CSS 调整样式。

社交链接

在每个页面底部显示社交媒体图标：

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

支持的平台

链接列

在社交图标上方添加链接分组：

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

版权信息

添加 copyright 后，它会显示在页脚底部一行，位于"Powered by Jamdesk"链接旁边：

{
  "footer": {
    "copyright": "© 2026 Acme Inc. All rights reserved."
  }
}

这是纯文本。Markdown 和 HTML 会按原样显示，因此请将链接放入链接列中。换行符会转换为空格，字符上限为 200。请直接输入 © 字符本身，因为 © 会原样显示。

为每种语言设置不同的页脚

在多语言站点中，navigation.languages 中的任一条目都可以拥有自己的 footer，其字段与顶层页脚相同：

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

某语言的页脚会替换顶层页脚，不会进行合并，因此如需保留某些内容，请一并复制过来。未设置自身 footer 的语言将使用顶层页脚。如需为某一语言隐藏页脚，请参见语言。

设置页脚样式

页脚的 class 名称在各版本之间保持不变，因此针对它们编写的自定义 CSS 将持续有效。例如，以下代码会将列标题设为大写，并将 GitHub 图标设为紫色：

.jd-footer-column-title {
  text-transform: uppercase;
  letter-spacing: 0.05em;
}

.jd-footer-social[data-platform="github"] {
  color: #6e40c9;
}

完整列表请参见自定义 CSS。

在特定页面隐藏页脚

使用 frontmatter 可在单个页面上隐藏页脚：

---
title: Landing Page
hideFooter: true
---

适用于自定义落地页，或页脚影响页面展示的情况。

Jamdesk 品牌

默认情况下，文档页面的页脚会显示"Powered by Jamdesk"链接。你可以将其移除。

隐藏品牌标识

要移除 Jamdesk 品牌标识：

1. 进入 Jamdesk 控制台中的 Settings
2. 找到 Build Settings 部分
3. 关闭 Show Jamdesk Branding
4. 触发一次新的构建

完整品牌配置示例

一份完整的品牌配置：

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

自定义域名

在 Jamdesk 控制台中添加你的域名：

1. 进入 Settings → Domains
2. 添加你的域名（例如 docs.yourcompany.com）
3. 按照提示配置 DNS
4. 等待验证完成

此后你的文档将通过自定义域名加载，并自动启用 SSL。

接下来做什么？