SEO 和元数据

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

Nuxt 的 head 标签管理由 Unhead 提供支持。它提供了合理的默认值、若干强大的组合式函数以及众多配置选项来管理应用的 head 和 SEO 元标签。

Nuxt 配置

在你的 nuxt.config.ts 中提供一个 app.head 属性，可让你静态地自定义整个应用的 head。

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

通常建议在此处设置不会改变的标签，例如站点默认标题、语言和 favicon。

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

你也可以在下文 Types 列出的任意键中提供值。

默认标签

为确保网站开箱即用，Nuxt 默认提供一些标签以保证良好兼容性。

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

大多数站点不需要覆盖这些默认值，但你可以使用带键的快捷方式来更新它们。

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

useHead

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

app/app.vue
<script setup lang="ts">
useHead({
  title: 'My App',
  meta: [
    { name: 'description', content: 'My amazing site.' },
  ],
  bodyAttrs: {
    class: 'test',
  },
  script: [{ innerHTML: 'console.log(\'Hello world\')' }],
})
</script>

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

useSeoMeta

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

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

app/app.vue
<script setup lang="ts">
useSeoMeta({
  title: 'My Amazing Site',
  ogTitle: 'My Amazing Site',
  description: 'This is my amazing site, let me tell you all about it.',
  ogDescription: 'This is my amazing site, let me tell you all about it.',
  ogImage: 'https://example.com/image.png',
  twitterCard: 'summary_large_image',
})
</script>
Read more in Docs > 4 X > API > Composables > Use Seo Meta.

组件

虽然在所有情况下都推荐使用 useHead，但你也可能更倾向于在模板中使用组件来定义 head 标签。

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

<Head> 和 <Body> 可以接受嵌套的元标签（出于审美原因），但这不会影响嵌套元标签在最终 HTML 中的实际渲染位置。

app/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。

功能

响应式

所有属性都支持响应式，通过提供一个 computed 值、getter 或响应式对象即可。

<script setup lang="ts">
const description = ref('My amazing site.')

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

标题模板

你可以使用 titleTemplate 选项为站点标题提供动态模板。例如，你可以在每个页面标题中添加站点名称。

titleTemplate 可以是一个字符串（其中 %s 将替换为标题），也可以是一个函数。

如果你想使用函数（以获得完全的控制），那么不能在 nuxt.config 中设置它。建议改为在你的 app.vue 文件中设置，这样它会应用到站点的所有页面：

<script setup lang="ts">
useHead({
  titleTemplate: (titleChunk) => {
    return titleChunk ? `${titleChunk} - Site Title` : 'Site Title'
  },
})
</script>

现在，如果你在站点的其他页面上使用 useHead 将标题设置为 My Page，浏览器标签中的标题将显示为 'My Page - Site Title'。你也可以传递 null 来默认使用 'Site Title'。

模板参数

你可以使用 templateParams 在 titleTemplate 中提供除了默认 %s 之外的额外占位符。这允许更动态的标题生成。

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

Body 标签

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

例如：

<script setup lang="ts">
useHead({
  script: [
    {
      src: 'https://third-party-script.com',
      // valid options are: 'head' | 'bodyClose' | 'bodyOpen'
      tagPosition: 'bodyClose',
    },
  ],
})
</script>

示例

使用 definePageMeta

在你的 app/pages/ 目录 中，你可以将 definePageMeta 与 useHead 一起使用，以基于当前路由设置元信息。

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

pages/some-page.vue
<script setup lang="ts">
definePageMeta({
  title: 'Some Page',
})
</script>

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

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

useHead({
  meta: [{ property: 'og:title', content: `App Name - ${route.meta.title}` }],
})
</script>
Read and edit a live example in Docs > 4 X > Examples > Features > Meta Tags.
Read more in Docs > 4 X > Guide > Directory Structure > App > Pages > #page Metadata.

动态标题

在下面的示例中，titleTemplate 要么设置为带有 %s 占位符的字符串，要么设置为函数，这允许为 Nuxt 应用的每个路由更灵活地动态设置页面标题：

app/app.vue
<script setup lang="ts">
useHead({
  // as a string,
  // where `%s` is replaced with the title
  titleTemplate: '%s - Site Title',
})
</script>
app/app.vue
<script setup lang="ts">
useHead({
  // or as a function
  titleTemplate: (productCategory) => {
    return productCategory
      ? `${productCategory} - Site Title`
      : 'Site Title'
  },
})
</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>