跳到主要内容

头部元数据

自定义头部元数据​

道格龙（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，你不需要这样做

内容插件（如 docs 和 blog）提供了像 description、keywords 和 image 这样的头部元数据选项，它们会自动应用于 description 和 og:description。而如果使用 <head> 标签，你将需要手动声明两个元数据标签。

Markdown 页面描述​

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

默认情况下，描述是内容的第一行，并会经过一些处理以转换为纯文本。例如，以下文件...

# 标题

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

...将会有默认的描述："主要内容... 可能包含一些链接或重点"。然而，这个功能并非设计得完美无缺。当它无法生成合理的描述时，你可以通过头部元数据明确提供一个：

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

# 标题

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