跳转到主要内容

​
标题

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

​
创建标题

使用 # 符号创建不同层级的标题： 
## 主节标题
### 小节标题
#### 小小节标题
使用具描述性且含有关键字的标题，清楚表明后续内容。这将同时提升用户的导航体验和搜索引擎优化效果。
---MDX_CONTENTEND--- 默认情况下，标题会包含可点击的锚点链接，方便用户直接跳转到特定章节。你可以在 HTML 或 React 的标题中使用 noAnchor 属性来禁用这些锚点链接。 
<h2 noAnchor>
不带锚点链接的标题
</h2>
当使用 noAnchor 时，标题不会显示锚点徽章，点击标题文本也不会将锚点链接复制到剪贴板。

​
文本格式

我们支持大部分 Markdown 格式，用于强调和设置文本样式。

​
基本格式

将以下格式应用于你的文本：
样式语法示例结果
粗体**text****important note**important note
斜体_text__emphasis_emphasis
删除线~text~~deprecated feature~deprecated feature

​
组合格式

你可以组合使用不同的格式样式： 
**_粗体加斜体_**
**~~粗体加删除线~~**
*~~斜体加删除线~~**
加粗和斜体
加粗和删除线
斜体和删除线

​
上标与下标

用于数学表达式或脚注时，请使用 HTML 标签：
类型语法示例结果
上标<sup>text</sup>example<sup>2</sup>example2
下标<sub>text</sub>example<sub>n</sub>examplen
链接有助于用户在页面之间跳转并访问外部资源。使用描述性链接文本可提升无障碍性和用户体验。 使用根相对路径链接到文档中的其他页面： 
[快速上手](/quickstart)
[步骤](/components/steps)
快速开始
步骤
请避免使用类似 [page](../page) 的相对链接，因为它们加载更慢，且无法像以根路径为基准的链接一样得到有效优化。
对于外部资源，请包含完整的URL： 
[Markdown 指南](https://www.markdownguide.org/)
Markdown指南 你可以使用命令行工具检查文档中的断链： 
mint 检查断链

​
引用块

引用块用于在内容中突出显示关键信息、引用或示例。

​
单行引用

在文本前添加 > 以创建引用： 
> 这是一段凸显于主体内容的引文。
这是一段在正文中凸显的引用。

​
多行块引用

适用于较长的引用或多段内容： 
> 这是多行引用的第一段。
>
> 这是第二段，之间用带有 `>` 的空行分隔。
这是一个多行引用的第一段。 这是第二段，中间通过带有 > 的空行进行分隔。
谨慎使用引用，以保持其视觉效果和表达重点。针对备注、警告等信息，建议改用提示框。

​
数学表达式

我们支持使用 LaTeX 渲染数学表达式和方程。

​
行内数学

行内数学表达式请使用单个美元符号 $： 
勾股定理表明，在直角三角形中，满足 $(a^2 + b^2 = c^2)$。
勾股定理表明，在直角三角形中，a2+b2=c2a^2 + b^2 = c^2。

​
独立公式

对于独立显示的公式，请使用双美元符号 $$： 
$$
E = mc^2
$$
E=mc2E = mc^2
使用 LaTeX 需遵循规范的数学语法。请参考 LaTeX 文档 了解完整的语法指南。

​
换行与间距

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

​
段落分隔

使用空行分隔段落： 
这是第一段。

这是第二段，中间以空行分隔。
这是第一段。 这是第二段，之间有一个空行分隔。

​
手动换行

在段落中需要强制换行时，请使用 HTML 中的 <br /> 标签： 
此行到此结束。<br />
下一行从这里开始。
这一行到此结束。
这一行从新的一行开始。
在大多数情况下，使用空行分段比手动换行更有助于提升可读性。

​
最佳实践

​
内容组织

  • 使用标题建立清晰的内容层级
  • 遵循正确的标题顺序（不要从 H2 跳到 H4）
  • 编写描述性、包含关键字的标题文本

​
文本格式

  • 使用加粗来强调重点，不要整段文字都加粗
  • 斜体仅用于术语、标题或轻微强调
  • 避免过度使用格式，以免分散对内容的注意力
  • 使用具描述性的链接文本，避免使用“点击这里”或“了解更多”
  • 内部链接使用以站点根目录为基准的相对路径
  • 定期检查链接，避免出现失效引用