mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
4b465465dd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
174 lines
5.2 KiB
Plaintext
174 lines
5.2 KiB
Plaintext
---
|
||
title: "字体"
|
||
description: "使用 Google Fonts 或自托管字体文件,为标题、正文和代码块自定义文档站点的排版样式。"
|
||
keywords: ["Google Fonts", "本地字体", "自定义排版"]
|
||
boost: 3
|
||
---
|
||
|
||
可为整站,或分别为标题与正文字体设置自定义字体。你可以使用 Google Fonts、本地字体文件,或外部托管的字体。默认字体因主题而异。
|
||
|
||
在 `docs.json` 中使用 [fonts 属性](/zh/organize/settings-appearance#fonts) 配置字体。
|
||
|
||
<div id="google-fonts">
|
||
## Google Fonts
|
||
</div>
|
||
|
||
当你在 `docs.json` 中指定字体族名称时,Mintlify 会自动加载 [Google Fonts](https://fonts.google.com)。
|
||
|
||
```json docs.json
|
||
"fonts": {
|
||
"family": "Inter"
|
||
}
|
||
```
|
||
|
||
<div id="local-fonts">
|
||
## 本地字体
|
||
</div>
|
||
|
||
要使用本地字体,请将字体文件放在项目目录中,并在 `docs.json` 配置中进行引用。
|
||
|
||
<div id="setting-up-local-fonts">
|
||
### 设置本地字体
|
||
</div>
|
||
|
||
<Steps>
|
||
<Step title="将字体文件添加到项目">
|
||
例如,创建一个 `fonts` 目录并添加字体文件:
|
||
|
||
```text
|
||
your-project/
|
||
├── fonts/
|
||
│ ├── InterDisplay-Regular.woff2
|
||
│ └── InterDisplay-Bold.woff2
|
||
├── docs.json
|
||
└── ...
|
||
```
|
||
</Step>
|
||
|
||
<Step title="在 docs.json 中配置字体">
|
||
从项目根目录使用相对路径引用本地字体:
|
||
|
||
```json docs.json
|
||
{
|
||
"fonts": {
|
||
"family": "InterDisplay",
|
||
"source": "/fonts/InterDisplay-Regular.woff2",
|
||
"format": "woff2",
|
||
"weight": 400
|
||
}
|
||
}
|
||
```
|
||
</Step>
|
||
</Steps>
|
||
|
||
<div id="local-fonts-for-headings-and-body">
|
||
### 标题与正文字体的本地字体
|
||
</div>
|
||
|
||
在你的 `docs.json` 中分别为标题和正文配置本地字体:
|
||
|
||
```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
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
<div id="externally-hosted-fonts">
|
||
## 外部托管字体
|
||
</div>
|
||
|
||
在 `docs.json` 中通过引用字体源的 URL 来使用外部托管的字体:
|
||
|
||
```json docs.json
|
||
{
|
||
"fonts": {
|
||
"family": "Hubot Sans",
|
||
"source": "https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2",
|
||
"format": "woff2",
|
||
"weight": 400
|
||
}
|
||
}
|
||
```
|
||
|
||
<div id="font-configuration-reference">
|
||
## 字体配置参考
|
||
</div>
|
||
|
||
<ResponseField name="fonts" type="object">
|
||
文档站点的字体配置。
|
||
|
||
<Expandable title="Fonts">
|
||
<ResponseField name="family" type="string" required>
|
||
字体系列名称,例如 “Inter” 或 “Playfair Display”。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="weight" type="number">
|
||
字重,例如 400 或 700。可变字体支持更精确的字重,如 550。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="source" type="string (uri)">
|
||
字体来源的 URL,例如 `https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2`,或本地字体文件路径,例如 `/assets/fonts/InterDisplay.woff2`。当你指定 Google 字体的 `family` 名称时会自动加载 Google Fonts,因此无需提供 source 的 URL。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="format" type="'woff' | 'woff2'">
|
||
字体文件格式。使用 `source` 字段时为必填。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="heading" type="object">
|
||
覆盖标题专用的字体设置。
|
||
|
||
<Expandable title="Heading">
|
||
<ResponseField name="family" type="string" required>
|
||
标题的字体系列名称。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="weight" type="number">
|
||
标题字重。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="source" type="string (uri)">
|
||
字体来源的 URL,例如 `https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2`,或标题使用的本地字体文件路径。当你指定 Google 字体的 `family` 名称时会自动加载 Google Fonts,因此无需提供 source 的 URL。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="format" type="'woff' | 'woff2'">
|
||
标题的字体文件格式。使用 `source` 字段时为必填。
|
||
</ResponseField>
|
||
</Expandable>
|
||
</ResponseField>
|
||
|
||
<ResponseField name="body" type="object">
|
||
覆盖正文专用的字体设置。
|
||
|
||
<Expandable title="Body">
|
||
<ResponseField name="family" type="string" required>
|
||
正文的字体系列名称。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="weight" type="number">
|
||
正文字重。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="source" type="string (uri)">
|
||
字体来源的 URL,例如 `https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2`,或正文使用的本地字体文件路径。当你指定 Google 字体的 `family` 名称时会自动加载 Google Fonts,因此无需提供 source 的 URL。
|
||
</ResponseField>
|
||
|
||
<ResponseField name="format" type="'woff' | 'woff2'">
|
||
正文的字体文件格式。使用 `source` 字段时为必填。
|
||
</ResponseField>
|
||
</Expandable>
|
||
</ResponseField>
|
||
</Expandable>
|
||
</ResponseField> |