头部元数据
自定义头部元数据
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) 或 **强调** 。