boolean
| object
undefined
Configuration to enable the application’s SSG (Static Site Generation) feature.
This configuration takes effect only when SSG is enabled. Please read the Static Site Generation documentation to understand how to enable SSG and its use cases.
The SSG feature is closely related to routing. It is recommended to understand the routing solution before using SSG.
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.
output.ssg
can also be configured per entry, with the rules for effective configurations determined by the entry's routing method.
For example, given the following directory structure, there are conventional routing entry entryA
and manual routing entry entryB
:
You can specify different SSG configurations for entryA
and entryB
:
For more information on the default behavior of conventional routing and manual routing after enabling SSG, please read Static Site Generation.
When the value type is Object
, the following attributes can be configured.
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, and the id
in params
will be replaced with modernjs
.
The configuration method for multiple entries is the same as for a single entry, so it will not be explained further here.