mintlify__docs/zh/create/text.mdx

---
title: "文本格式"
description: "了解如何格式化文本、创建标题和设置内容样式。"
keywords: ["Markdown 格式", "文本样式", "标题", "锚点链接"]
---

<div id="headers">
  ## 标题
</div>

标题用于组织你的内容并创建导航锚点。它们会显示在目录中，帮助用户快速浏览你的文档。

<div id="creating-headers">
  ### 创建标题
</div>

使用 `#` 符号创建不同层级的标题：

```mdx
## 主要章节标题
### 子章节标题
#### 子子章节标题
```

<Tip>
  使用具描述性且富含关键词的标题，清晰表明后续内容。这有助于提升用户导航与搜索引擎优化。
</Tip>

<div id="disabling-anchor-links">
  ### 禁用锚点链接
</div>

默认情况下，标题会包含可点击的锚点链接，便于用户直接跳转到特定章节。你可以在 HTML 或 React 的标题中使用 `noAnchor` 属性来禁用这些锚点链接。

<CodeGroup>
  ```mdx HTML header example
  <h2 noAnchor>
  无锚点链接的标题
  </h2>
  ```

  ```mdx React header example
  <Heading level={2} noAnchor>
  无锚点链接的标题
  </Heading>
  ```
</CodeGroup>

当使用 `noAnchor` 时，标题将不会显示锚点徽标，点击标题文本也不会将锚点链接复制到剪贴板。

<div id="text-formatting">
  ## 文本格式
</div>

我们支持大多数用于强调和美化文本的 Markdown 格式。

<div id="basic-formatting">
  ### 基本格式
</div>

将以下格式样式应用于你的文本：

| 样式 | 语法 | 示例 | 结果 |
|-------|--------|---------|--------|
| **加粗** | `**text**` | `**important note**` | **重要提示** |
| *斜体* | `_text_` | `_emphasis_` | *强调* |
| ~~删除线~~ | `~text~` | `~deprecated feature~` | ~~已废弃功能~~ |

<div id="combining-formats">
  ### 组合格式
</div>

你可以将多种格式样式组合使用：

```mdx
**_粗体和斜体_**
**~~粗体和删除线~~**
*~~斜体和删除线~~*
```

***加粗和斜体***<br />
**~~加粗和删除线~~**<br />
*~~斜体和删除线~~*

<div id="superscript-and-subscript">
  ### 上标与下标
</div>

用于数学表达式或脚注时，请使用 HTML 标签：

| 类型 | 语法 | 示例 | 结果 |
|------|--------|---------|--------|
| 上标 | `<sup>text</sup>` | `example<sup>2</sup>` | example<sup>2</sup> |
| 下标 | `<sub>text</sub>` | `example<sub>n</sub>` | example<sub>n</sub> |

<div id="links">
  ## 链接
</div>

链接可帮助用户在页面之间跳转并访问外部资源。使用具描述性的链接文本可提升可访问性与用户体验。

<div id="internal-links">
  ### 内部链接
</div>

使用以站点根目录为基准的相对路径，链接到文档中的其他页面：

```mdx
[快速入门](/quickstart)
[步骤](/components/steps)
```

[快速上手](/zh/quickstart)<br />
[步骤](/zh/components/steps)

<div id="external-links">
  ### 外部链接
</div>

对于外部资源，请填写完整的 URL：

```mdx
[Markdown 指南](https://www.markdownguide.org/)
```

[Markdown 指南](https://www.markdownguide.org/)

<div id="broken-links">
  ### 断链
</div>

你可以使用[命令行界面（CLI）](/zh/installation)检查文档中的断链：

```bash
mint broken-links
```

<div id="blockquotes">
  ## 引用
</div>

引用用于在内容中突出重要信息、引语或示例。

<div id="single-line-blockquotes">
  ### 单行引用
</div>

在文本前添加 `>` 以创建引用：

```mdx
> 这是一段从主要内容中突出显示的引用。
```

> 这是一句从正文中突出的引用。

<div id="multi-line-blockquotes">
  ### 多行块引用
</div>

对于较长的引用或包含多个段落的内容：

```mdx
> 这是多行引用块的第一段。
>
> 这是第二段，通过带有 `>` 的空行分隔。
```

> 这是多行引用的第一段。
>
> 这是第二段，之间以带有 `>` 的空行分隔。

<Tip>
  谨慎使用引用，以保持其视觉效果和表达语义。对于备注、警告等信息，建议使用[标注](/zh/components/callouts)。
</Tip>

<div id="mathematical-expressions">
  ## 数学表达式
</div>

我们支持使用 LaTeX 渲染数学表达式和公式。你可以在 `docs.json` 的 [settings](/zh/organize/settings#param-latex) 中配置 `styles.latex`，以覆盖自动检测。

<div id="inline-math">
  ### 行内数学
</div>

对于行内数学表达式，请使用单个美元符号 `$`：

```mdx
勾股定理表明，在直角三角形中 $(a^2 + b^2 = c^2)$。
```

勾股定理指出，在直角三角形中有 $(a^2 + b^2 = c^2)$。

<div id="block-equations">
  ### 块级公式
</div>

要书写独立显示的公式，请使用双美元符号 `$$`：

```mdx
$$
E = mc^2
$$
```

$$
E = mc^2
$$

<Info>
  使用 LaTeX 需遵循规范的数学语法。有关完整的语法说明，请参阅 [LaTeX 文档](https://www.latex-project.org/help/documentation/)。
</Info>

<div id="line-breaks-and-spacing">
  ## 换行与间距
</div>

通过控制间距和换行来提升内容的可读性。

<div id="paragraph-breaks">
  ### 段落分隔
</div>

使用空行分隔段落：

```mdx
这是第一段。

这是第二段，由空行分隔。
```

这是第一段。

这是第二段，中间隔着一个空行。

<div id="manual-line-breaks">
  ### 手动换行
</div>

在段落中使用 HTML `<br />` 标签来进行强制换行：

```mdx
这一行在此结束。<br />
这一行从新行开始。
```

这一行到此结束。<br />
下一行从新的一行开始。

<Tip>
  在大多数情况下，用空行分隔段落比手动插入换行符更有助于提升可读性。
</Tip>

<div id="best-practices">
  ## 最佳实践
</div>

<div id="content-organization">
  ### 内容组织
</div>

* 使用标题构建清晰的内容层级
* 遵循正确的标题层级（不要从 H2 直接跳到 H4）
* 编写描述性且包含关键词的标题文本

<div id="text-formatting">
  ### 文本格式
</div>

* 使用加粗来突出重点，不要整段加粗
* 将斜体用于术语、标题或轻微强调
* 避免过度格式化，以免分散对内容的注意力

### 链接

* 使用描述性链接文本，而非“点击这里”或“了解更多”
* 对内部链接使用根相对路径
* 定期测试链接，避免出现失效链接