v3.16
Nuxt on GitHub

SEO 和元数据

使用强大的头部配置、组合式函数和组件提升你的 Nuxt 应用的 SEO。

Nuxt 的头部标签管理由 Unhead 提供支持。它提供了合理的默认值、多个强大的组合式函数以及众多配置选项，帮助你管理应用的头部和 SEO 元数据标签。

Nuxt 配置

在 nuxt.config.ts 中提供 app.head 属性，可以静态地为整个应用定制头部。

此方法不允许提供响应式数据。我们建议在 app.vue 中使用 useHead()。

在这里设置不会更改的标签是个好习惯，例如默认站点标题、语言和 favicon。

nuxt.config.ts
export default defineNuxtConfig({
  app: {
    head: {
      title: 'Nuxt', // 默认备用标题
      htmlAttrs: {
        lang: 'en',
      },
      link: [
        { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' },
      ]
    }
  }
})

你还可以提供以下 类型 中列出的任何键。

默认标签

Nuxt 默认提供了一些标签，以确保你的网站开箱即用效果良好：

  • viewport: width=device-width, initial-scale=1
  • charset: utf-8

虽然大多数网站无需覆盖这些默认值，但你可以使用键控快捷方式更新它们。

nuxt.config.ts
export default defineNuxtConfig({
  app: {
    head: {
      // 更新 Nuxt 默认值
      charset: 'utf-16',
      viewport: 'width=device-width, initial-scale=1, maximum-scale=1',
    }
  }
})

useHead

useHead 组合式函数支持响应式输入，允许你以编程方式管理头部标签。

app.vue
<script setup lang="ts">
useHead({
  title: '我的应用',
  meta: [
    { name: 'description', content: '我的精彩网站。' }
  ],
  bodyAttrs: {
    class: 'test'
  },
  script: [ { innerHTML: 'console.log(\'Hello world\')' } ]
})
</script>

我们建议查看 useHead 和 useHeadSafe 组合式函数。

useSeoMeta

useSeoMeta 组合式函数允许你以对象形式定义站点的 SEO 元数据标签，并提供完整的类型安全。

这可以帮助你避免拼写错误和常见错误，例如使用 name 而不是 property。

app.vue
<script setup lang="ts">
useSeoMeta({
  title: '我的精彩网站',
  ogTitle: '我的精彩网站',
  description: '这是我的精彩网站，让我为你详细介绍。',
  ogDescription: '这是我的精彩网站，让我为你详细介绍。',
  ogImage: 'https://example.com/image.png',
  twitterCard: 'summary_large_image',
})
</script>
阅读更多 Docs > API > Composables > Use Seo Meta.

组件

虽然在所有情况下都推荐使用 useHead，但你可能更喜欢在模板中使用组件来定义头部标签。

Nuxt 为此提供了以下组件：<Title>、<Base>、<NoScript>、<Style>、<Meta>、<Link>、<Body>、<Html> 和 <Head>。注意这些组件的首字母大写，以确保不使用无效的原生 HTML 标签。

<Head> 和 <Body> 可以接受嵌套的元数据标签（出于美观考虑），但这不会影响嵌套元数据标签在最终 HTML 中的渲染位置。

app.vue
<script setup lang="ts">
const title = ref('Hello World')
</script>

<template>
  <div>
    <Head>
      <Title>{{ title }}</Title>
      <Meta name="description" :content="title" />
      <Style>
      body { background-color: green; }
      </Style>
    </Head>

    <h1>{{ title }}</h1>
  </div>
</template>

建议将你的组件包裹在 <Head> 或 <Html> 组件中，因为这样标签去重会更直观。

类型

以下是用于 useHead、app.head 和组件的非响应式类型。

interface MetaObject {
  title?: string
  titleTemplate?: string | ((title?: string) => string)
  templateParams?: Record<string, string | Record<string, string>>
  base?: Base
  link?: Link[]
  meta?: Meta[]
  style?: Style[]
  script?: Script[]
  noscript?: Noscript[];
  htmlAttrs?: HtmlAttributes;
  bodyAttrs?: BodyAttributes;
}

更多详细类型请参见 @unhead/vue。

功能

响应式

所有属性都支持响应式，你可以提供计算属性、getter 或响应式对象。

<script setup lang="ts">
const description = ref('我的精彩网站。')

useHead({
  meta: [
    { name: 'description', content: description }
  ],
})
</script>

标题模板

你可以使用 titleTemplate 选项提供动态模板来自定义站点的标题。例如，你可以将站点名称添加到每个页面的标题中。

titleTemplate 可以是一个字符串，其中 %s 会被标题替换，或者是一个函数。

如果你想使用函数（以获得完全控制），则无法在 nuxt.config 中设置。建议在 app.vue 文件中设置，它将应用于站点上的所有页面：

<script setup lang="ts">
useHead({
  titleTemplate: (titleChunk) => {
    return titleChunk ? `${titleChunk} - 站点标题` : '站点标题';
  }
})
</script>

现在，如果你在站点其他页面使用 useHead 将标题设置为 我的页面，浏览器标签中的标题将显示为“我的页面 - 站点标题”。你也可以传递 null 以默认显示“站点标题”。

模板参数

你可以使用 templateParams 在 titleTemplate 中提供除默认 %s 之外的额外占位符，从而实现更动态的标题生成。

<script setup lang="ts">
useHead({
  titleTemplate: (titleChunk) => {
    return titleChunk ? `${titleChunk} %separator %siteName` : '%siteName';
  },
  templateParams: {
    siteName: '站点标题',
    separator: '-'
  }
})
</script>

Body 标签

对于适用的标签，你可以使用 tagPosition: 'bodyClose' 选项将它们追加到 <body> 标签的末尾。

例如：

<script setup lang="ts">
useHead({
  script: [
    {
      src: 'https://third-party-script.com',
      // 有效选项为：'head' | 'bodyClose' | 'bodyOpen'
      tagPosition: 'bodyClose'
    }
  ]
})
</script>

示例

使用 definePageMeta

在 pages/ 目录 中，你可以使用 definePageMeta 结合 useHead 根据当前路由设置元数据。

例如，你可以先设置当前页面标题（此标题通过宏在构建时提取，因此无法动态设置）：

pages/some-page.vue
<script setup lang="ts">
definePageMeta({
  title: '某个页面'
})
</script>

然后在你的布局文件中，你可以使用之前设置的路由元数据：

layouts/default.vue
<script setup lang="ts">
const route = useRoute()

useHead({
  meta: [{ property: 'og:title', content: `应用名称 - ${route.meta.title}` }]
})
</script>
阅读并编辑实时示例中的内容 Docs > Examples > Features > Meta Tags.
阅读更多 Docs > Guide > Directory Structure > Pages > #page Metadata.

动态标题

在下面的示例中，titleTemplate 被设置为带有 %s 占位符的字符串或一个函数，这为 Nuxt 应用的每个路由动态设置页面标题提供了更大的灵活性：

app.vue
<script setup lang="ts">
useHead({
  // 作为字符串，
  // 其中 `%s` 会被标题替换
  titleTemplate: '%s - 站点标题',
})
</script>
app.vue
<script setup lang="ts">
useHead({
  // 或作为函数
  titleTemplate: (productCategory) => {
    return productCategory
      ? `${productCategory} - 站点标题`
      : '站点标题'
  }
})
</script>

nuxt.config 也可以用来设置页面标题。然而，nuxt.config 不允许动态设置页面标题。因此，建议在 app.vue 文件中使用 titleTemplate 来添加动态标题，然后将其应用于 Nuxt 应用的所有路由。

外部 CSS

下面的示例展示了如何使用 useHead 组合式函数的 link 属性或使用 <Link> 组件启用 Google Fonts：

<script setup lang="ts">
useHead({
  link: [
    {
      rel: 'preconnect',
      href: 'https://fonts.googleapis.com'
    },
    {
      rel: 'stylesheet',
      href: 'https://fonts.googleapis.com/css2?family=Roboto&display=swap',
      crossorigin: ''
    }
  ]
})
</script>