跳到主要内容

头部元数据

自定义头部元数据​

Docusaurus 会自动为您在 <html>、<head> 和 <body> 中设置有用的页面元数据。您可以在 Markdown 文件中使用 <head> 标签添加额外的元数据（或覆盖现有的元数据）：

markdown-features-head-metadata.mdx
---
id: head-metadata
title: 头部元数据
---

<head>
  <html className="some-extra-html-class" />
  <body className="other-extra-body-class" />
  <title>头部元数据自定义标题！</title>
  <meta charSet="utf-8" />
  <meta name="twitter:card" content="summary" />
  <link rel="canonical" href="https://docusaurus.io/docs/markdown-features/head-metadata" />
</head>

# 头部元数据

我的文本

这个 <head> 声明已添加到当前 Markdown 文档中作为演示。打开浏览器开发者工具并检查此页面的元数据是如何受到影响的。

备注

此功能基于 Docusaurus 的 <Head> 组件构建。请参考 react-helmet 获取详尽的文档。

对于常规 SEO，您不需要这个

内容插件（如文档和博客）提供了前置元数据选项，如 description、keywords 和 image，这些将自动应用于 description 和 og:description，而使用 <head> 标签时，您需要手动声明两个元数据标签。

Markdown 页面描述​

Markdown 页面的描述元数据可能在比头部元数据更多的地方使用。例如，文档插件的生成的类别索引使用描述元数据作为文档卡片。

默认情况下，描述是第一个有内容的行，并尽力将其转换为纯文本。例如，以下文件...

# 标题

主要内容... 可能包含一些 [链接](./file.mdx) 或 **强调**。

...将具有默认描述 "主要内容... 可能包含一些链接或强调"。但是，它并不旨在完全可用。在无法生成合理描述的情况下，您可以通过前置元数据显式提供一个：

---
description: 这个描述将覆盖默认描述。
---

# 标题

主要内容... 可能包含一些 [链接](./file.mdx) 或 **强调**。