• 简体中文

      • output.ssg

      • 类型： boolean | object
      • 默认值： undefined

      开启应用 SSG 功能的配置

      开启 SSG 功能

      此配置需要在开启 SSG 功能情况下才会生效。请阅读 静态站点生成 文档了解如何开启 SSG 功能及使用场景。

      前置阅读

      SSG 功能使用与路由关联性较大，建议使用前先了解路由方案。

      Info
      • 单入口建议使用 output.ssg。
      • 多入口建议优先使用 output.ssgByEntries。
      • 当 output.ssg 为 true 且未配置 output.ssgByEntries 时，所有入口下的所有路由都会作为 SSG 路由处理。

      Boolean 类型

      当该配置设置为 true 时，将会默认开启所有入口的 SSG 功能。对自控式路由而言，将会渲染入口的根路由。对约定式路由而言，将会渲染入口中每一条路由。

      export default defineConfig({
  output: {
    ssg: true,
  },
});

      Object 类型

      当值类型为 Object 时，可以配置如下属性。

      配置类型

      type SSGRouteOptions =
  | string
  | {
      url: string;
      headers?: Record<string, any>;
    };

type SSGOptions = {
  headers?: Record<string, any>;
  routes?: SSGRouteOptions[];
};

      示例

      下面的示例配置中，SSG 会渲染 /、/about 和 /user/:id 三条路由对应的页面。

      对于 /user/:id 路由，会在请求头中添加 cookies，并指定具体的路径。

      modern.config.ts（单入口）
      export default defineConfig({
  output: {
    ssg: {
      routes: [
        '/',
        '/about',
        {
          url: '/user/modernjs',
          headers: {
            cookies: 'name=modernjs',
          },
        },
      ],
    },
  },
});