字体

配置自定义字体

你可以为整个站点设置自定义字体，或分别为标题和正文设置不同的字体。可使用 Google Fonts、本地字体文件，或外部托管的字体。默认字体因主题而异。

字体由 docs.json 中的 fonts 属性 控制。

​

Google Fonts

当你在 docs.json 中指定字体族名称时，Mintlify 会自动加载 Google Fonts。

docs.json

"fonts": {
  "family": "Inter"
}

​

本地字体

要使用本地字体，请将字体文件放在项目目录中，并在 docs.json 配置中进行引用。

​

设置本地字体

1. 将字体文件添加到项目

   例如，创建一个 fonts 目录并添加字体文件：

   your-project/
   ├── fonts/
   │   ├── InterDisplay-Regular.woff2
   │   └── InterDisplay-Bold.woff2
   ├── docs.json
   └── ...
   

2. 在 docs.json 中配置字体

   从项目根目录使用相对路径引用本地字体：

   docs.json

   {
     "fonts": {
       "family": "InterDisplay",
       "source": "/fonts/InterDisplay-Regular.woff2",
       "format": "woff2",
       "weight": 400
     }
   }
   

​

标题与正文字体的本地字体

在你的 docs.json 中分别为标题和正文配置本地字体：

docs.json

{
  "fonts": {
    "heading": {
      "family": "InterDisplay",
      "source": "/fonts/InterDisplay-Bold.woff2",
      "format": "woff2",
      "weight": 700
    },
    "body": {
      "family": "InterDisplay",
      "source": "/fonts/InterDisplay-Regular.woff2",
      "format": "woff2",
      "weight": 400
    }
  }
}

​

外部托管字体

在 docs.json 中通过引用字体源的 URL 来使用外部托管的字体：

docs.json

{
  "fonts": {
    "family": "Hubot Sans",
    "source": "https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2",
    "format": "woff2",
    "weight": 400
  }
}

​

字体配置参考

fonts · object

文档站点的字体配置。

显示 Fonts

family · string · required

字体系列名称，例如 “Inter” 或 “Playfair Display”。

weight · number

字重，例如 400 或 700。可变字体支持更精确的字重，如 550。

source · string (uri)

字体来源的 URL，例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2，或本地字体文件路径，例如 /assets/fonts/InterDisplay.woff2。当你指定 Google 字体的 family 名称时会自动加载 Google Fonts，因此无需提供 source 的 URL。

format · 'woff' | 'woff2'

字体文件格式。使用 source 字段时为必填。

heading · object

覆盖标题专用的字体设置。

显示 Heading

family · string · required

标题的字体系列名称。

weight · number

标题字重。

source · string (uri)

字体来源的 URL，例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2，或标题使用的本地字体文件路径。当你指定 Google 字体的 family 名称时会自动加载 Google Fonts，因此无需提供 source 的 URL。

format · 'woff' | 'woff2'

标题的字体文件格式。使用 source 字段时为必填。

body · object

覆盖正文专用的字体设置。

显示 Body

family · string · required

正文的字体系列名称。

weight · number

正文字重。

source · string (uri)

字体来源的 URL，例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2，或正文使用的本地字体文件路径。当你指定 Google 字体的 family 名称时会自动加载 Google Fonts，因此无需提供 source 的 URL。

format · 'woff' | 'woff2'

正文的字体文件格式。使用 source 字段时为必填。