跳到主要内容
版本：3.8.1

搜索引擎优化 (SEO)

Docusaurus 通过多种方式支持搜索引擎优化。

全局元数据​

通过站点配置为整个网站提供全局元属性。元数据将以键值对的形式作为属性名和值，全部渲染到 HTML 的 <head> 中。metadata 属性是声明 <meta> 标签的便捷方式，但也可以通过 headTags 属性在 <head> 中注入任意标签。

docusaurus.config.js
export default {
  themeConfig: {
    // Declare some <meta> tags
    metadata: [
      {name: 'keywords', content: 'cooking, blog'},
      {name: 'twitter:card', content: 'summary_large_image'},
    ],
  },
  headTags: [
    // Declare a <link> preconnect tag
    {
      tagName: 'link',
      attributes: {
        rel: 'preconnect',
        href: 'https://example.com',
      },
    },
    // Declare some json-ld structured data
    {
      tagName: 'script',
      attributes: {
        type: 'application/ld+json',
      },
      innerHTML: JSON.stringify({
        '@context': 'https://schema.org/',
        '@type': 'Organization',
        name: 'Meta Open Source',
        url: 'https://opensource.fb.com/',
        logo: 'https://opensource.fb.com/img/logos/Meta-Open-Source.svg',
      }),
    },
  ],
};

Docusaurus 开箱即用地添加了一些元数据。例如，如果您配置了 i18n，您将获得一个 hreflang 备用链接。

要了解更多关于元标签类型的信息，请访问 MDN 文档。

单页面元数据​

与全局元数据类似，Docusaurus 也允许为单个页面添加元信息。请遵循此指南配置 <head> 标签。简而言之：

my-markdown-page.mdx
# A cooking guide

<head>
  <meta name="keywords" content="cooking, blog" />
  <meta name="twitter:card" content="summary_large_image" />
  <link rel="preconnect" href="https://example.com" />
  <script type="application/ld+json">
    {JSON.stringify({
      '@context': 'https://schema.org/',
      '@type': 'Organization',
      name: 'Meta Open Source',
      url: 'https://opensource.fb.com/',
      logo: 'https://opensource.fb.com/img/logos/Meta-Open-Source.svg',
    })}
  </script>
</head>

Some content...

Docusaurus 会自动为每个 Markdown 页面添加 description、title、规范 URL 链接和其他有用的元数据。它们可以通过front matter 进行配置。

---
title: Title for search engines; can be different from the actual heading
description: A short description of this page
image: a thumbnail image to be shown in social media cards
keywords: [keywords, describing, the main topics]
---

创建 React 页面时，在 Layout 中添加这些字段也能改善 SEO。

提示

建议使用front matter来设置 description 和 keywords 等字段：Docusaurus 会自动将其应用于 description 和 og:description，而如果使用 <head> 标签，则需要手动声明两个元数据标签。

信息

官方插件都支持以下front matter：title、description、keywords 和 image。请参阅它们各自的 API 文档以获取更多front matter支持。

对于 JSX 页面，您可以使用 Docusaurus 的 <Head> 组件。

my-react-page.jsx
import React from 'react';
import Layout from '@theme/Layout';
import Head from '@docusaurus/Head';

export default function page() {
  return (
    <Layout title="Page" description="A React page demo">
      <Head>
        <meta property="og:image" content="image.png" />
        <meta name="twitter:card" content="summary_large_image" />
        <link rel="preconnect" href="https://example.com" />
        <script type="application/ld+json">
          {JSON.stringify({
            '@context': 'https://schema.org/',
            '@type': 'Organization',
            name: 'Meta Open Source',
            url: 'https://opensource.fb.com/',
            logo: 'https://opensource.fb.com/img/logos/Meta-Open-Source.svg',
          })}
        </script>
      </Head>
      {/* ... */}
    </Layout>
  );
}
提示

为了方便，默认主题的 <Layout> 组件接受 title 和 description 作为属性。

静态 HTML 生成​

Docusaurus 是一个静态站点生成器——每个 URL 路由都会静态生成 HTML 文件，这有助于搜索引擎更轻松地发现您的内容。

图片元描述​

图片的 alt 标签告诉搜索引擎图片的内容，并在图片无法视觉显示时使用，例如使用屏幕阅读器时，或者图片损坏时。Markdown 中通常支持 alt 标签。

您还可以为图片添加标题——这虽然对 SEO 影响不大，但在鼠标悬停在图片上方时会显示为工具提示，通常用于提供提示。

![Docusaurus banner](./assets/docusaurus-asset-example-banner.png 'Image title')
https://:3000

Docusaurus banner

丰富的搜索信息​

Docusaurus 博客开箱即用地支持丰富的搜索结果，以获得最佳搜索引擎体验。这些信息是根据您在博客/全局配置中的元信息生成的。为了获得丰富的搜索信息的好处，请填写文章的发布日期、作者和图片等信息。在此处阅读更多关于元信息的内容。

Robots 文件​

robots.txt 文件规定了搜索引擎的行为，即哪些内容应该显示，哪些不应该。您可以将其作为静态资源提供。以下内容将允许所有请求访问所有子页面：

static/robots.txt
User-agent: *
Disallow:

更多关于 robots 文件的信息，请查阅Google 文档。

警告

重要：robots.txt 文件不会阻止 HTML 页面被索引。

要阻止整个 Docusaurus 网站被索引，请使用 noIndex 站点配置。一些托管服务商也可能允许您配置 X-Robots-Tag: noindex HTTP 标头（GitHub Pages 不支持此功能）。

要阻止单个页面被索引，请使用 <meta name="robots" content="noindex"> 作为页面元数据。更多关于robots 元标签的信息。

站点地图文件​

Docusaurus 提供了 @docusaurus/plugin-sitemap 插件，默认随 preset-classic 一起提供。它会自动生成一个 sitemap.xml 文件，该文件在生产构建后可在 https://example.com/[baseUrl]/sitemap.xml 访问。此站点地图元数据有助于搜索引擎爬虫更准确地抓取您的网站。

提示

站点地图插件会自动过滤包含 noindex robots 元指令的页面。

例如，/examples/noIndex 未包含在 Docusaurus sitemap.xml 文件中，因为它包含以下页面元数据：

<head>
  <meta name="robots" content="noindex, nofollow" />
</head>

Docusaurus 使用您的文件名作为链接，但您始终可以使用 slugs 更改它，请参阅此教程了解更多详情。

结构化内容​

搜索引擎依靠 HTML 标记（如 <h2>、<table> 等）来理解网页的结构。当 Docusaurus 渲染您的页面时，会使用语义化标记（例如 <aside>、<nav>、<main>）来划分页面的不同部分，帮助搜索引擎定位侧边栏、导航栏和主页面内容等部分。

大多数 CommonMark 语法都有其对应的 HTML 标签。通过在项目中始终如一地使用 Markdown，您将使搜索引擎更容易理解您的页面内容。