标题用于组织内容并创建导航锚点。它们会显示在目录中,帮助用户快速浏览文档。
使用 #
符号创建不同层级的标题:
## 主节标题
### 小节标题
#### 子小节标题
使用具描述性且包含关键词的标题,清晰传达后续内容。这有助于提升用户导航体验和搜索引擎优化效果。
默认情况下,标题包含可点击的锚点链接,用户可以直接跳转到特定小节。你可以在 HTML 或 React 标题中使用 noAnchor
属性来禁用这些锚点链接。
<h2 noAnchor>
不带锚点链接的标题
</h2>
使用 noAnchor
后,标题不会显示锚点图标,点击标题文本也不会将锚点链接复制到剪贴板。
我们支持大多数 Markdown 格式,用于强调和美化文本。
将以下格式应用于你的文本:
样式 | 语法 | 示例 | 结果 |
---|
加粗 | **text** | **important note** | important note |
斜体 | _text_ | _emphasis_ | emphasis |
删除线 | ~text~ | ~deprecated feature~ | deprecated feature |
你可以将不同的格式样式组合使用:
**_bold and italic_**
**~~bold and strikethrough~~**
*~~italic and strikethrough~~**
加粗和斜体
加粗和删除线
斜体和删除线
用于数学表达式或脚注时,请使用 HTML 标签:
类型 | 语法 | 示例 | 结果 |
---|
上标 | <sup>text</sup> | example<sup>2</sup> | example2 |
下标 | <sub>text</sub> | example<sub>n</sub> | examplen |
链接帮助用户在页面之间导航并访问外部资源。使用清晰、描述性的链接文本可提升无障碍性和用户体验。
使用以站点根路径为基准的链接路径,指向文档中的其他页面:
[Quickstart](/quickstart)
[Steps](/components/steps)
Quickstart
Steps
避免使用类似 [page](../page)
的相对链接,因为它们加载更慢,且无法像根路径链接那样高效优化。
对于外部资源,请使用完整的 URL:
[Markdown Guide](https://www.markdownguide.org/)
Markdown Guide
你可以使用 CLI 检查文档中的失效链接:
引用块用于在内容中突出显示重要信息、引用或示例。
在文本前添加 >
以创建引用:
> This is a quote that stands out from the main content.
这是一段从主体内容中更为醒目的引用。
对于较长的引用或包含多个段落的情况:
> This is the first paragraph of a multi-line blockquote.
>
> This is the second paragraph, separated by an empty line with `>`.
这是多行引用的第一段。
这是第二段,中间通过带有 >
的空行分隔。
谨慎使用引用,以保持其视觉冲击力和语义。对于备注、警告等信息,建议使用提示。
我们支持使用 LaTeX 渲染数学表达式与方程。
对行内数学表达式使用单个美元符号 $
:
The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.
勾股定理指出,直角三角形中有 (a2+b2=c2)。
对于独立的公式,请使用双美元符号 $$
:
E=mc2
LaTeX 需要使用正确的数学语法。有关完整的语法指南,请参阅 LaTeX 文档。
通过控制间距与换行来提升内容的可读性。
请用空行分隔段落:
This is the first paragraph.
This is the second paragraph, separated by a blank line.
这是第一段。
这是第二段,用空行分隔。
在段落中使用 HTML <br />
标签来强制换行:
This line ends here.<br />
This line starts on a new line.
这一行到此结束。
下一行将从新的一行开始。
在大多数情况下,用空行分隔段落比手动换行更有利于阅读。
- 使用标题建立清晰的内容层级
- 遵循正确的标题层级(不要从 H2 跳到 H4)
- 撰写有描述性且富含关键词的标题
- 使用加粗进行重点强调,不要整段加粗
- 将斜体用于术语、标题或轻微强调
- 避免过度格式化,以免分散对内容的注意力
- 使用具描述性的链接文本,避免使用“点击这里”或“了解更多”
- 内部链接使用根相对路径
- 定期检查链接,避免出现死链