Summary

ssg

• Type: boolean | { experimentalWorker?: boolean; experimentalLoose?: boolean; }
• Default: true

Whether to enable static site generation. Rspress enable it by default to generate CSR outputs and SSG outputs.

If your document site is only required to be used in CSR scenarios, you can set ssg to false, and Rspress will only generate CSR outputs.

import { defineConfig } from '@rspress/core';

export default defineConfig({
  ssg: false,
});

experimentalWorker

• Type: boolean
• Default: false

After enabled, you can use Worker to speed up the SSG process. It is suitable for large document sites and is based on tinypool.

experimentalLoose

• Type: boolean
• Default: false

After enabled, some errors in the SSG process will be ignored and other pages will continue to be generated, but the SSG of some pages will be missing. It is suitable for SSG errors that are used by large document sites to bypass a small number of pages. It is not recommended to actively enable them.

Related Issue

close #2272

Checklist

• Tests updated (or not required).
• Documentation updated (or not required).