#output.ssg

• Type: boolean | object
• Default Value: undefined

Configuration to enable the application’s SSG (Static Site Generation) feature.

#Boolean Type

When this configuration is set to true, the SSG feature will be enabled for all entries by default. For manual routing, the root route of the entry will be rendered. For conventional routing, each route in the entry will be rendered.

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

#Object Type

When the value type is Object, the following attributes can be configured.

#Configuration Type

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

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

#Example

In the example configuration below, SSG will render the pages corresponding to the /, /about, and /user/:id routes.

For the /user/:id route, cookies will be added to the request headers.

export default defineConfig({
  output: {
    ssg: {
      routes: [
        '/',
        '/about',
        {
          url: '/user/modernjs',
          headers: {
            cookies: 'name=modernjs',
          },
        },
      ],
    },
  },
});