SEO 和元数据

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

Nuxt 的 head 标签管理是通过 Unhead 提供的。它提供了合理的默认设置、多个强大的组合函数以及众多配置选项来管理您的应用的 head 和 SEO meta 标签。

Nuxt 配置

在您的 nuxt.config.ts 中提供 app.head 属性，使您能够静态自定义整个应用的 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 组合函数支持响应式输入，使您可以以编程方式管理您的 head 标签。

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 meta 标签定义为具有完整类型安全的对象。

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

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 > API > Composables > Use Seo Meta.

组件

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

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

<Head> 和 <Body> 可以接受嵌套的 meta 标签（出于美学原因），但这不会影响嵌套的 meta 标签在最终 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('My amazing site.')

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

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

useSeoMeta({
  description
})
</script>

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

<template>
  <div>
    <Meta name="description" :content="description" />
  </div>
</template>

标题模板

您可以使用 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'。

体标签

您可以在适用的标签上使用 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: '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 > Examples > Features > Meta Tags.

Read more in Docs > Guide > Directory Structure > Pages > #page Metadata.

动态标题

在下面的示例中，titleTemplate 设置为带有 %s 占位符的字符串或为 function，这使得在 Nuxt 应用的每个路由上动态设置页面标题时具有更大的灵活性：

app.vue

<script setup lang="ts">
useHead({
  // 作为字符串，
  // 在这里 `%s` 被标题替换
  titleTemplate: '%s - Site Title',
})
</script>

app.vue

<script setup lang="ts">
useHead({
  // 或作为一个函数
  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>

<template>
  <div>
    <Link rel="preconnect" href="https://fonts.googleapis.com" />
    <Link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto&display=swap" crossorigin="" />
  </div>
</template>

报告问题或者在 GitHub 上编辑此页面

路由

Nuxt 文件系统路由为 `pages/` 目录中的每个文件创建一个路由。

过渡

使用 Vue 或原生浏览器视图过渡在页面和布局之间应用过渡效果。