Jamdesk Documentation logo

主题

选择内置主题以控制排版、布局、间距和深色模式,并自定义颜色以匹配品牌。

在 docs.json 中设置 theme,以控制布局、排版、间距和深色模式行为。共有五种主题:jam(默认)、nebula、pulsar、halo 和 dusk。

屏幕截图显示的是英文界面。

docs.json
{
  "theme": "jam"
}

选择主题前,先在本文档中试用每种主题。在侧边栏顶部的 Preview a theme 下选择主题。在移动设备上,请打开导航菜单。预览会持续显示,直到关闭浏览器。

可用主题

Jam 主题预览

默认主题。采用带有页眉和 Logo 的布局,背景使用从主色派生的径向渐变。边框圆角为 6-24px。

查看在线示例

{
  "theme": "jam"
}

字体

每种主题都包含从 Google Fonts 加载的字体:

主题标题正文代码
JamInterInterJetBrains Mono
NebulaIBM Plex MonoIBM Plex MonoIBM Plex Mono
PulsarInterInterJetBrains Mono
HaloFigtreeFigtreeJetBrains Mono
DuskIBM Plex SerifInterJetBrains Mono

我们建议使用默认字体;这些字体经过调整,与各主题相匹配。如果需要更换字体,可以在 docs.json 中设置 fonts,将整个网站切换为 Google Font:

{
  "fonts": {
    "family": "Lora"
  }
}

标题和正文可以使用不同的字体:

{
  "fonts": {
    "heading": { "family": "Space Grotesk" },
    "body": { "family": "Inter" }
  }
}

任何 Google Font 均可使用。只需设置 family,构建过程就会自动获取字体。若要自行托管自定义字体,请添加 source(URL 或相对于 / 的路径)和 format:

{
  "fonts": {
    "family": "AcmeSans",
    "source": "/fonts/acme-sans.woff2",
    "format": "woff2"
  }
}

设置 weight 可让正文字体更细(或更粗)。这对 Geist 这类精致的几何字体很有用:

{
  "fonts": {
    "family": "Geist",
    "weight": 200
  }
}

weight 只设置正文字重;标题仍使用各主题较粗的字重,以保持字体层级。body 格式也支持此设置:"body": { "family": "Geist", "weight": 200 }。

如果需要进行 fonts 字段以外的调整(覆盖代码字体、分别调整各级标题的字重,或加载非 Google 网络字体),请参阅自定义 CSS。

自定义颜色

覆盖默认配色,以匹配品牌形象:

{
  "theme": "jam",
  "colors": {
    "primary": "#635BFF",
    "light": "#7C75FF",
    "dark": "#4F46E5"
  }
}
颜色用途
primary链接、按钮、强调元素
light悬停状态、高亮
dark激活状态、深色模式强调元素

更改会在下次构建后生效。在本地开发环境中,请重启开发服务器以查看更改。

使用 Coolors 或 Realtime Colors 等配色工具生成协调的配色方案。

需要调整的不只是颜色?自定义 CSS 可用于覆盖页面颜色、间距、边框圆角、提示框样式和组件细节。主题设置默认样式;对于 CSS 能调整的其他内容,则可以使用自定义 CSS。

暗色模式

所有主题都支持深色模式。默认情况下,Jamdesk 会遵循用户的系统偏好,并在导航栏中提供切换开关。配色方案会自动适配。

在 docs.json 中设置 appearance,将网站固定为特定模式:

{
  "appearance": {
    "default": "dark",
    "strict": true
  }
}
字段值默认值说明
default"system" | "light" | "dark""system"首次访问时的初始模式
strictbooleanfalse为 true 时隐藏导航栏切换开关,让访客保持在 default 指定的模式

只设置 default 可建议初始模式,同时仍允许用户切换。添加 strict: true 可完全移除切换开关,并将网站锁定为该模式。

开发期间可使用导航栏切换开关测试深色模式,也可以在 DevTools 中模拟:

  1. 打开 DevTools
  2. 按 Cmd+Shift+P(Mac)或 Ctrl+Shift+P(Windows)
  3. 搜索 "Emulate CSS prefers-color-scheme: dark"

如需精细控制深色模式样式,请使用自定义 CSS。

下一步

品牌设置

自定义 Logo、颜色和 favicon

自定义 CSS

使用自己的 CSS 覆盖主题样式

导航

配置标签、分组和页面结构