static

產生

當 SSG 應該從另一個模組（例如 Vite 外掛）產生時，請使用此函數。此函數應該傳入入口模組和 Qwik City Plan 的路徑。

export declare function generate(
  opts: StaticGenerateOptions,
): Promise<StaticGenerateResult>;

參數

類型

說明

opts

StaticGenerateOptions

Promise<StaticGenerateResult>

編輯此區塊

StaticGenerateOptions

export interface StaticGenerateOptions extends StaticGenerateRenderOptions

擴展： StaticGenerateRenderOptions

屬性

修飾字

類型

說明

basePathname?

字串

（可選） 默認為 /

qwikCityPlanModulePath

字串

匯出預設 @qwik-city-plan 的 Qwik City Plan 模組的路徑。

renderModulePath

字串

匯出預設渲染函數的 SSR 模組的路徑。在大多數情況下，它會是 ./src/entry.ssr.tsx。

rootDir?

字串

（可選）

編輯此區塊

StaticGenerateRenderOptions

export interface StaticGenerateRenderOptions extends RenderOptions

擴展： RenderOptions

屬性

修飾字

類型

說明

emit404Pages?

布林值

（可選） 如果靜態建置不應寫入自定義或預設的 404.html 頁面，則設定為 false。默認為 true。

emitData?

布林值

（可選） 如果產生的 q-data.json 數據檔案不應寫入磁碟，則設定為 false。默認為 true。

emitHtml?

布林值

（可選） 如果產生的靜態 HTML 檔案不應寫入磁碟，則設定為 false。如果 SSG 應該只將 q-data.json 檔案寫入磁碟，則設定為 false 很有用。默認為 true。

exclude?

字串[]

（可選） 定義相對於來源 routes 目錄的不應靜態產生的檔案系統路由。接受萬用字元行為。這不應包含「基本」路徑名。exclude 的優先順序始終高於 include。

include?

字串[]

（可選） 定義相對於來源 routes 目錄的應靜態產生的檔案系統路由。接受萬用字元行為。這不應包含「基本」路徑名。如果未提供，則所有路由都將靜態產生。exclude 的優先順序始終高於 include。

log?

'debug'

（可選） 日誌級別。

maxTasksPerWorker?

數字

（可選） 每個工作程序一次執行的最大任務數。默認為 20。

maxWorkers?

數字

（可選） 產生靜態頁面時要使用的最大工作程序數。默認為可用的 CPU 數量。

來源

字串

URL origin 是由協定 (protocol) 和主機名稱 (domain) 組合而成的。例如，https://qwik.dev.org.tw 的協定是 https://，網域名稱為 qwik.dev。但是，origin 不包含 pathname。

origin 用於在靜態網站生成 (SSG) 期間提供完整的 URL，並模擬完整的 URL，而不僅僅是 pathname。例如，為了呈現正確的規範標籤 URL 或 sitemap.xml 中的 URL，也必須提供 origin。

如果網站的路徑名稱不是以 / 開頭，請在 Qwik City 設定選項中使用 basePathname 選項。

outDir

字串

應寫入靜態檔案的檔案系統目錄。

sitemapOutFile?

字串 | null

（選用）要將 sitemap.xml 寫入的檔案系統路徑。預設為 sitemap.xml 並寫入 outDir 的根目錄。設定為 null 將會阻止建立 Sitemap。

編輯此區塊

StaticGenerateResult

export interface StaticGenerateResult

屬性

修飾字

類型

說明

數字

數字

數字

字串[]