output.ssg
- Type:
boolean | object - Default Value:
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.
- Use
output.ssgfor single-entry apps. - For multi-entry apps, prefer
output.ssgByEntries. - If
output.ssgistrueandoutput.ssgByEntriesis not set, SSG is enabled for all entries, using the route collection rules below.
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, non-dynamic routes and paths returned by page-level ssgParams generators will be rendered. Dynamic routes without a generator are skipped.
Object Type
When the value type is Object, the following attributes can be configured.
Configuration Type
Route Collection
- With
routesomitted or set to[], conventional routing automatically includes non-dynamic routes and paths generated byssgParamsin file-systempage.data.tsor$.data.tsfiles. Generator discovery does not apply to config routes. - With a non-empty
routeslist, render the listed paths and paths fromssgParams. Other non-dynamic routes are skipped. When an explicit route andssgParamsresolve to the same URL, render it once using the explicit route's options, includingheadersandoutput. - Setting the entry's SSG option to
falsealso disables its parameter generators.
These rules also apply to each entry configured through output.ssgByEntries. See generating parameters alongside a loader for parameter types, encoding, and examples.
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.