chore(router): rename 'static/' to 'ssg/' for clarity

Author: wmertens

packages/docs/src/routes/api/index.tsx

@@ -10,13 +10,13 @@ import qwikRouterMiddlewareNetlifyEdgeApiData from './qwik-router-middleware-net
 import qwikRouterMiddlewareNodeApiData from './qwik-router-middleware-node/api.json';
 import qwikRouterMiddlewareRequestHandlerApiData from './qwik-router-middleware-request-handler/api.json';
 import qwikRouterMiddlewareVercelEdgeApiData from './qwik-router-middleware-vercel-edge/api.json';
-import qwikRouterStaticApiData from './qwik-router-static/api.json';
+import qwikRouterSsgApiData from './qwik-router-ssg/api.json';
 import qwikRouterViteAzureSwaApiData from './qwik-router-vite-azure-swa/api.json';
 import qwikRouterViteCloudRunApiData from './qwik-router-vite-cloud-run/api.json';
 import qwikRouterViteCloudflarePagesApiData from './qwik-router-vite-cloudflare-pages/api.json';
 import qwikRouterViteNetlifyEdgeApiData from './qwik-router-vite-netlify-edge/api.json';
 import qwikRouterViteNodeServerApiData from './qwik-router-vite-node-server/api.json';
-import qwikRouterViteStaticApiData from './qwik-router-vite-static/api.json';
+import qwikRouterViteSsgApiData from './qwik-router-vite-ssg/api.json';
 import qwikRouterViteVercelApiData from './qwik-router-vite-vercel/api.json';
 import qwikRouterApiData from './qwik-router/api.json';
 import qwikServerApiData from './qwik-server/api.json';
@@ -35,13 +35,13 @@ const apiData = {
   'qwik-router-middleware-request-handler': qwikRouterMiddlewareRequestHandlerApiData,
   'qwik-router-middleware-vercel-edge': qwikRouterMiddlewareVercelEdgeApiData,
   'qwik-router-middleware-firebase': qwikRouterMiddlewareFirebaseApiData,
-  'qwik-router-static': qwikRouterStaticApiData,
+  'qwik-router-ssg': qwikRouterSsgApiData,
   'qwik-router-vite-azure-swa': qwikRouterViteAzureSwaApiData,
   'qwik-router-vite-cloud-run': qwikRouterViteCloudRunApiData,
   'qwik-router-vite-cloudflare-pages': qwikRouterViteCloudflarePagesApiData,
   'qwik-router-vite-node-server': qwikRouterViteNodeServerApiData,
   'qwik-router-vite-netlify-edge': qwikRouterViteNetlifyEdgeApiData,
-  'qwik-router-vite-static': qwikRouterViteStaticApiData,
+  'qwik-router-vite-ssg': qwikRouterViteSsgApiData,
   'qwik-router-vite-vercel': qwikRouterViteVercelApiData,
   'qwik-optimizer': qwikOptimizerApiData,
   'qwik-server': qwikServerApiData,
@@ -126,7 +126,7 @@ export const ApiMemberWrapper = component$(({ id, data, filters }: any) => {
       <h2
         data-icon={isCollapsed.value ? '→' : '↓'}
         class="section-title cursor-pointer"
-        onClick$={(e) => isCollapsed.value = !isCollapsed.value }
+        onClick$={() => isCollapsed.value = !isCollapsed.value }
       >
         <span>{data.id}</span>
       </h2>

packages/docs/src/routes/api/qwik-router-ssg/api.json

@@ -0,0 +1,62 @@
+{
+  "id": "qwik-router-ssg",
+  "package": "@qwik.dev/qwik-router/ssg",
+  "members": [
+    {
+      "name": "generate",
+      "id": "generate",
+      "hierarchy": [
+        {
+          "name": "generate",
+          "id": "generate"
+        }
+      ],
+      "kind": "Function",
+      "content": "Use this function when SSG should be generated from another module, such as a Vite plugin. This function's should be passed the paths of the entry module and Qwik Router Plan.\n\n\n```typescript\nexport declare function generate(opts: SsgOptions): Promise<SsgResult>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nopts\n\n\n</td><td>\n\n[SsgOptions](#staticgenerateoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nPromise&lt;[SsgResult](#staticgenerateresult)<!-- -->&gt;",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-router/src/ssg/index.ts",
+      "mdFile": "router.generate.md"
+    },
+    {
+      "name": "SsgRenderOptions",
+      "id": "ssgrenderoptions",
+      "hierarchy": [
+        {
+          "name": "SsgRenderOptions",
+          "id": "ssgrenderoptions"
+        }
+      ],
+      "kind": "Interface",
+      "content": "```typescript\nexport interface SsgRenderOptions extends RenderOptions \n```\n**Extends:** RenderOptions\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[emit404Pages?](./router.ssgrenderoptions.emit404pages.md)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Set to `false` if the static build should not write custom or default `404.html` pages. Defaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[emitData?](./router.ssgrenderoptions.emitdata.md)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Set to `false` if the generated `q-data.json` data files should not be written to disk. Defaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[emitHtml?](./router.ssgrenderoptions.emithtml.md)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Set to `false` if the generated static HTML files should not be written to disk. Setting to `false` is useful if the SSG should only write the `q-data.json` files to disk. Defaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[exclude?](./router.ssgrenderoptions.exclude.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Defines file system routes relative to the source `routes` directory that should not be static generated. Accepts wildcard behavior. This should not include the \"base\" pathname. `exclude` always takes priority over `include`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[include?](./router.ssgrenderoptions.include.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Defines file system routes relative to the source `routes` directory that should be static generated. Accepts wildcard behavior. This should not include the \"base\" pathname. If not provided, all routes will be static generated. `exclude` always takes priority over `include`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[log?](./router.ssgrenderoptions.log.md)\n\n\n</td><td>\n\n\n</td><td>\n\n'debug'\n\n\n</td><td>\n\n_(Optional)_ Log level.\n\n\n</td></tr>\n<tr><td>\n\n[maxTasksPerWorker?](./router.ssgrenderoptions.maxtasksperworker.md)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_ Maximum number of tasks to be running at one time per worker. Defaults to `20`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[maxWorkers?](./router.ssgrenderoptions.maxworkers.md)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_ Maximum number of workers to use while generating the static pages. Defaults to the number of CPUs available.\n\n\n</td></tr>\n<tr><td>\n\n[origin](./router.ssgrenderoptions.origin.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nThe URL `origin`<!-- -->, which is a combination of the scheme (protocol) and hostname (domain). For example, `https://qwik.dev` has the protocol `https://` and domain `qwik.dev`<!-- -->. However, the `origin` does not include a `pathname`<!-- -->.\n\nThe `origin` is used to provide a full URL during Static Site Generation (SSG), and to simulate a complete URL rather than just the `pathname`<!-- -->. For example, in order to render a correct canonical tag URL or URLs within the `sitemap.xml`<!-- -->, the `origin` must be provided too.\n\nIf the site also starts with a pathname other than `/`<!-- -->, please use the `basePathname` option in the Qwik Router config options.\n\n\n</td></tr>\n<tr><td>\n\n[outDir](./router.ssgrenderoptions.outdir.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nFile system directory where the static files should be written.\n\n\n</td></tr>\n<tr><td>\n\n[sitemapOutFile?](./router.ssgrenderoptions.sitemapoutfile.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n_(Optional)_ File system path to write the `sitemap.xml` to. Defaults to `sitemap.xml` and written to the root of the `outDir`<!-- -->. Setting to `null` will prevent the sitemap from being created.\n\n\n</td></tr>\n</tbody></table>",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-router/src/ssg/types.ts",
+      "mdFile": "router.ssgrenderoptions.md"
+    },
+    {
+      "name": "StaticGenerateOptions",
+      "id": "staticgenerateoptions",
+      "hierarchy": [
+        {
+          "name": "StaticGenerateOptions",
+          "id": "staticgenerateoptions"
+        }
+      ],
+      "kind": "Interface",
+      "content": "```typescript\nexport interface SsgOptions extends SsgRenderOptions \n```\n**Extends:** [SsgRenderOptions](#ssgrenderoptions)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[basePathname?](./router.staticgenerateoptions.basepathname.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ Defaults to `/`\n\n\n</td></tr>\n<tr><td>\n\n[qwikCityPlanModulePath?](./router.staticgenerateoptions.qwikcityplanmodulepath.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[qwikRouterConfigModulePath](./router.staticgenerateoptions.qwikrouterconfigmodulepath.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nPath to the Qwik Router Config module exporting the default `@qwik-router-config`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[renderModulePath](./router.staticgenerateoptions.rendermodulepath.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nPath to the SSR module exporting the default render function. In most cases it'll be `./src/entry.ssr.tsx`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[rootDir?](./router.staticgenerateoptions.rootdir.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-router/src/ssg/types.ts",
+      "mdFile": "router.staticgenerateoptions.md"
+    },
+    {
+      "name": "StaticGenerateResult",
+      "id": "staticgenerateresult",
+      "hierarchy": [
+        {
+          "name": "StaticGenerateResult",
+          "id": "staticgenerateresult"
+        }
+      ],
+      "kind": "Interface",
+      "content": "```typescript\nexport interface SsgResult \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[duration](./router.staticgenerateresult.duration.md)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[errors](./router.staticgenerateresult.errors.md)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[rendered](./router.staticgenerateresult.rendered.md)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[staticPaths](./router.staticgenerateresult.staticpaths.md)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-router/src/ssg/types.ts",
+      "mdFile": "router.staticgenerateresult.md"
+    }
+  ]
+}