跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

锚点标题

最后更新 查看 MarkdownAgent 设置

AnchorHeading 组件用于定义标题。具体而言,AnchorHeading 执行以下操作:

  1. 生成对应于标题的 URL 片段。
  2. 将 URL 片段格式化为兼容的语法。例如,将 & 替换为 -。
  3. 在每个片段处创建一个复制 URL 的按钮。
  4. 允许单独定义标题片段,而与标题本身的文本分开。
import { AnchorHeading } from "~/components";

<AnchorHeading title="How to use AnchorHeading" slug="use-anchorheading" depth={2} />

Markdown 文件(包括 partial)默认具有此行为,这是通过 rehype 插件应用的。因此,通常只有在组件内部自行编写标题或处理非 markdown 文件时,才需要使用 AnchorHeading 组件。

要在 Markdown 中覆盖赋予标题的 ID,请在行尾添加 MDX 注释:

## foo {/*bar*/}
{/* HTML: <h2 id="bar">foo</h2> */}

这篇文档对您有帮助吗?