v3.16
GitHub

预渲染

Nuxt允许在构建时静态渲染页面，以改善某些性能或SEO指标

Nuxt允许从您的应用程序中选择页面在构建时进行渲染。Nuxt将在请求时提供预构建的页面，而不是动态生成它们。

Read more in Nuxt 渲染模式.

基于爬虫的预渲染

使用 nuxi generate 命令 构建并预渲染您的应用程序，使用 Nitro 爬虫。此命令类似于将 nitro.static 选项设置为 true 的 nuxt build，或运行 nuxt build --prerender。

这将构建您的网站，启动一个 nuxt 实例，并默认预渲染根页面 / 以及其链接到的您网站的任何页面、他们链接到的任何页面，依此类推。

npx nuxi generate

您现在可以将 .output/public 目录部署到任何静态托管服务，或使用 npx serve .output/public 本地预览。

Nitro 爬虫的工作原理：

  1. 加载您应用程序的根路由 (/)、~/pages 目录中的任何非动态页面，以及 nitro.prerender.routes 数组中的任何其他路由。
  2. 将 HTML 和 payload.json 保存到 ~/.output/public/ 目录中，以便静态提供。
  3. 查找 HTML 中的所有锚标签 (<a href="...">) 以导航到其他路由。
  4. 对每个找到的锚标签重复步骤 1-3，直到没有更多锚标签可供爬取。

理解这一点很重要，因为未链接到可发现页面的页面无法自动预渲染。

阅读有关 nuxi generate 命令的更多信息。

选择性预渲染

您可以手动指定 Nitro 在构建期间将获取和预渲染的路由，或忽略您不想要预渲染的路由，例如在 nuxt.config 文件中的 /dynamic：

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    prerender: {
      routes: ["/user/1", "/user/2"],
      ignore: ["/dynamic"],
    },
  },
});

您可以将此与 crawlLinks 选项结合使用，以预渲染爬虫无法发现的一组路由，例如您的 /sitemap.xml 或 /robots.txt：

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    prerender: {
      crawlLinks: true,
      routes: ["/sitemap.xml", "/robots.txt"],
    },
  },
});

将 nitro.prerender 设置为 true 与将 nitro.prerender.crawlLinks 设置为 true 类似。

阅读 Nitro 文档中有关预渲染的更多信息。

最后，您可以使用 routeRules 手动配置此设置。

nuxt.config.ts
export default defineNuxtConfig({
  routeRules: {
    // 设置 prerender 为 true，以配置为预渲染
    "/rss.xml": { prerender: true },
    // 设置为 false，以配置为跳过预渲染
    "/this-DOES-NOT-get-prerendered": { prerender: false },
    // /blog 下的所有内容只要
    // 被其他页面链接就会被预渲染
    "/blog/**": { prerender: true },
  },
});
阅读有关 Nitro 的 routeRules 配置的更多信息。

作为简写，您还可以使用 defineRouteRules 在页面文件中配置此设置。

此功能是实验性的，要使用它，您必须在 nuxt.config 中启用 experimental.inlineRouteRules 选项。
pages/index.vue
<script setup>
// 或设置在页面级别
defineRouteRules({
  prerender: true,
});
</script>

<template>
  <div>
    <h1>主页</h1>
    <p>在构建时预渲染</p>
  </div>
</template>

这将转换为：

nuxt.config.ts
export default defineNuxtConfig({
  routeRules: {
    "/": { prerender: true },
  },
});

运行时预渲染配置

prerenderRoutes

您可以在 Nuxt 上下文 内部以运行时使用此功能，以添加更多路由供 Nitro 预渲染。

pages/index.vue
<script setup>
prerenderRoutes(["/some/other/url"]);
prerenderRoutes("/api/content/article/my-article");
</script>

<template>
  <div>
    <h1>当预渲染时这将注册其他路由以供预渲染</h1>
  </div>
</template>
Read more in prerenderRoutes.

prerender:routes Nuxt 钩子

在预渲染之前调用此钩子，以注册额外的路由。

nuxt.config.ts
export default defineNuxtConfig({
  hooks: {
    async "prerender:routes"(ctx) {
      const { pages } = await fetch("https://api.some-cms.com/pages").then(
        (res) => res.json(),
      );
      for (const page of pages) {
        ctx.routes.add(`/${page.name}`);
      }
    },
  },
});

prerender:generate Nitro 钩子

在预渲染期间对此钩子进行每个路由的调用。您可以使用此方法来精细处理每个要预渲染的路由。

nuxt.config.ts
export default defineNuxtConfig({
  nitro: {
    hooks: {
      "prerender:generate"(route) {
        if (route.route?.includes("private")) {
          route.skip = true;
        }
      },
    },
  },
});