跳转至主要内容

前言

元信息​

用于告知页面元信息的前言。

title​

页面的 <h1> 标题。此标题显示在页面顶部以及左侧导航栏中。

您无需将此文本添加为 <h1>，因为 Gatsby 会从 title 标签生成此标题。

注意

  • 您可以将 title 文本包裹在单引号中，但这并非强制性的。
  • 如果您将 title 文本包裹在单引号中，则不能在文本中包含撇号。

metaTitle​

页面的 <title> - 回退到 title (h1)。

此标签对于 Google SEO 很重要。如果需要，我们可以使 metaTitle 比 title 更具描述性。

为了获得良好的 SEO 效果，请在此标签中拼写出缩写，除非它们是行业标准。例如，拼写出 "Prisma Data Platform"，但使用缩写 "ORM" 是可以的。

注意

  • 您可以将 metaTitle 文本包裹在单引号中，但这并非强制性的。
  • 如果您将 metaTitle 文本包裹在单引号中，则不能在文本中包含撇号。

指定左侧导航栏中使用的不同标题，通常更短。

metaDescription​

页面的 <meta name="description" content="" />。

注意

  • 您可以将 metaDescription 文本包裹在单引号中，但这并非强制性的。
  • 如果您将 metaDescription 文本包裹在单引号中，则不能在文本中包含撇号。

配置导航的前言。

duration​

接受一个字符串，指定阅读文章的时长。

示例：duration: '15 分钟'

preview​

接受 true 或 false (默认为 false)。

在左侧导航栏中为页面添加一个 Preview 标签。

deprecated​

接受 true 或 false (默认为 false)。

在左侧导航栏中为页面添加一个 Deprecated 标签。

目录（右侧边栏）​

toc​

启用或禁用页面上的目录导航（默认为 false）。例如

toc: true

tocDepth​

控制页面内 ToC 中显示的标题深度

tocDepth: 2

注意：当前默认级别为 - h2

配置搜索的前言。

search​

接受 true 或 false (默认为 true)。

设置为 false 时，将从搜索结果中省略该页面。

search: false

页面内容​

配置页面内容的前言

langSwitcher​

接受一个语言数组，以便在页面中显示为下拉选项，以便在页面之间切换上下文

示例

langSwitcher: ['typescript', 'node']

dbSwitcher​

接受一个数据库选项数组，以便在页面中显示为下拉选项，以便在页面之间切换上下文

示例

dbSwitcher: ['postgresql', 'mysql', 'sqlserver', 'planetscale', 'cockroachdb']

设计​

配置页面视觉外观的前言。

wide​

接受 true 或 false (默认为 false)。

当设置为 'true' 时，此页面的内容宽度将为 988px，而不是默认的 748px。

示例

wide: true

注意

  • 请仅对包含难以阅读的宽表的页面使用此选项。