@modern-js/main-doc 2.8.0 → 2.10.0

package/en/configure/app/output/externals.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: externals
----
-
-# output.externals
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [output.externals](https://modernjs.dev/builder/en/api/config-output.html#outputexternals).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/output/externals.md'
-
-<Main />

package/en/configure/app/output/filename.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: filename
----
-
-# output.filename
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [output.filename](https://modernjs.dev/builder/en/api/config-output.html#outputfilename).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/output/filename.md'
-
-<Main />

package/en/configure/app/output/legal-comments.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: legalComments
----
-
-# output.legalComments
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [output.legalComments](https://modernjs.dev/builder/en/api/config-output.html#outputlegalcomments).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/output/legalComments.md'
-
-<Main />

package/en/configure/app/output/override-browserslist.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: overrideBrowserslist
----
-
-# output.overrideBrowserslist
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [output.overrideBrowserslist](https://modernjs.dev/builder/en/api/config-output.html#outputoverridebrowserslist).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/output/overrideBrowserslist.md'
-
-<Main />

package/en/configure/app/output/polyfill.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: polyfill
----
-
-# output.polyfill
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [output.polyfill](https://modernjs.dev/builder/en/api/config-output.html#outputpolyfill).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/output/polyfill.md'
-
-<Main />

package/en/configure/app/output/ssg.mdx

@@ -1,196 +0,0 @@
----
-sidebar_label: ssg
----
-
-# output.ssg
-
-- **Type:** `boolean` | `object` | `function`
-- **Default:** `undefined`
-
-Enable the SSG for **Self-controlled Routing** or **Conventional Routing**.
-
-:::info
-For more routes detail, see [routes](/guides/basic-features/routes).
-
-:::
-
-## Example
-
-### Single Entry
-
-When the configuration is set to `true`, the SSG of all entries will be enabled by default.
-
-For **self-controlled routing**, the root route of the entry will be rendered. For **convention routing**, every route in the entry will be rendered.
-
-For example, the `src/` directory has the following file structure that satisfies **conventional routing**:
-
-```bash
-.
-├── src
-│   └── routes
-│       ├── layout.tsx
-│       ├── page.tsx
-│       └── user
-│           ├── layout.tsx
-│           ├── page.tsx
-│           └── profile
-│               └── page.tsx
-```
-
-Make the following config in `modern.config.[tj]s`:
-
-```ts
-export default defineConfig({
-  output: {
-    ssg: true,
-  },
-});
-```
-
-After executing `pnpm build` to build the application. The `dist/` directory will generate three HTML for each of the three routes (only one HTML if SSG not enabled), and all HTML has been rendered.
-
-For example the following **self-controlled routing**:
-
-import SelfRouteExample from "@site-docs/components/self-route-example";
-
-<SelfRouteExample />
-
-Also using the above configuration, after executing `pnpm run build`, only the entry route `/` will generate the rendered HTML.
-
-### Multi Entries
-
-`output.ssg` can also be configured according to the entries, and the rules that the configuration takes effect are also determined by the entries routing method.
-
-例如以下目录结构：
-
-```bash
-.
-├── src
-│   ├── entryA
-│   │   └── routes
-│   │       ├── layout.tsx
-│   │       ├── page.tsx
-│   │       └── user
-│   │           ├── layout.tsx
-│   │           ├── page.tsx
-│   │           └── profile
-│   │               └── page.tsx
-│   └── entryB
-│       └── App.tsx
-```
-
-By default, all entryA entrances are rendered at build time after setting `output.ssg` to `true`. You can configure `false` to cancel the default behavior of the specified entries. For example, to cancel the rendering of the `entryA` at build time:
-
-```js
-export default defineConfig({
-  output: {
-    ssg: {
-      entryA: true,
-      entryB: false,
-    },
-  },
-});
-```
-
-### Configure Route
-
-As mentioned above, **Self-Controlled Routing** only enables SSG configuration for entries route by default.
-
-Set specific routes in `output.ssg` can tell Modern.js to enable the SSG of these client side routes. For example, the content of the above `src/App.tsx` file is:
-
-<SelfRouteExample />
-
-
-When set like this in `modern.config.[jt]s`, the `/about` route will also enable SSG:
-
-```js
-export default defineConfig({
-  output: {
-    ssg: {
-      routes: ['/', '/about'],
-    },
-  },
-});
-```
-
-Modern.js will automatically concat the complete URL according to the entry and hand it over to the SSG plugin to complete the rendering.
-
-Request headers can also be configured for specific entries or routes, for example:
-
-```js
-export default defineConfig({
-  output: {
-    ssg: {
-      headers: {},
-      routes: [
-        '/',
-        {
-          url: '/about',
-          headers: {},
-        },
-      ],
-    },
-  },
-});
-```
-
-:::info
-The `headers` set in the route override the `headers` set in the entry.
-
-:::
-
-### Prevent Default
-
-By default, **Conventional Routing** all turn on SSG. Modern.js provides another field to prevent the default SSG behavior.
-
-For example, the following directory structure ，`/`、`/user` and `/user/profle` all have SSG enabled:
-
-```bash
-.
-├── src
-│   └── routes
-│       ├── layout.tsx
-│       ├── page.tsx
-│       └── user
-│           ├── layout.tsx
-│           ├── page.tsx
-│           └── profile
-│               └── page.tsx
-```
-
-You can set this to disable the default behavior of a client-side route:
-
-```js
-export default defineConfig({
-  output: {
-    preventDefault: ['/user'],
-  },
-});
-```
-
-### Dynamic Params
-
-Some routes may be dynamic, such as the `/user/:id` in a self-controlled route or the route generated by the `user/[id]/page.tsx` file in a conventional route.
-
-configure specific parameters in `output.ssg` to render the route of the specified parameters, for example:
-
-```js
-export default defineConfig({
-  output: {
-    ssg: {
-      routes: [
-        {
-          url: '/user/:id',
-          params: [
-            {
-              id: 'modernjs',
-            },
-          ],
-        },
-      ],
-    },
-  },
-});
-```
-
-The features of dynamic routing and SSG is useful when generating static pages in real time based on CMS system.

package/en/configure/app/output/svg-default-export.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: svgDefaultExport
----
-
-# output.svgDefaultExport
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [output.svgDefaultExport](https://modernjs.dev/builder/en/api/config-output.html#outputsvgdefaultexport).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/output/svgDefaultExport.md'
-
-<Main />

package/en/configure/app/performance/build-cache.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: buildCache
----
-
-# performance.buildCache
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.buildCache](https://modernjs.dev/builder/en/api/config-performance.html#performancebuildcache).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/buildCache.md'
-
-<Main />

package/en/configure/app/performance/bundle-analyze.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: bundleAnalyze
----
-
-# performance.bundleAnalyze
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.bundleAnalyze](https://modernjs.dev/builder/en/api/config-performance.html#performancebundleanalyze).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/bundleAnalyze.md'
-
-<Main />

package/en/configure/app/performance/chunk-split.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: chunkSplit
----
-
-# performance.chunkSplit
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.chunkSplit](https://modernjs.dev/builder/en/api/config-performance.html#performancechunksplit).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/chunkSplit.md'
-
-<Main />

package/en/configure/app/performance/print-file-size.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: printFileSize
----
-
-# performance.printFileSize
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.printFileSize](https://modernjs.dev/builder/en/api/config-performance.html#performanceprintfilesize).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/printFileSize.md'
-
-<Main />

package/en/configure/app/performance/profile.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: profile
----
-
-# performance.profile
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.profile](https://modernjs.dev/builder/en/api/config-performance.html#performanceprofile).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/profile.md'
-
-<Main />

package/en/configure/app/performance/remove-console.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: removeConsole
----
-
-# performance.removeConsole
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.removeConsole](https://modernjs.dev/builder/en/api/config-performance.html#performanceremoveconsole).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/removeConsole.md'
-
-<Main />

package/en/configure/app/performance/remove-moment-locale.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: removeMomentLocale
----
-
-# performance.removeMomentLocale
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [performance.removeMomentLocale](https://modernjs.dev/builder/en/api/config-performance.html#performanceremovemomentlocale).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/performance/removeMomentLocale.md'
-
-<Main />

package/en/configure/app/security/check-syntax.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: checkSyntax
----
-
-# security.checkSyntax
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [security.checkSyntax](https://modernjs.dev/builder/en/api/config-security.html#securitychecksyntax).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/security/checkSyntax.md'
-
-<Main />

package/en/configure/app/security/sri.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: sri
----
-
-# security.sri
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [security.sri](https://modernjs.dev/builder/en/api/config-security.html#securitysri).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/security/sri.md'
-
-<Main />

package/en/configure/app/server/public-routes.mdx

@@ -1,26 +0,0 @@
----
-sidebar_label: publicRoutes
----
-
-# server.publicRoutes
-
-- **Type:** `Object`
-- **Default:** Automatic generation of server-level routing rules based on file conventions: One routing rule is generated per file of the application.
-
-This configuration option only applies to server-level routing, and you can customize the access route of resources in `config/public/`.
-
-The `key` of the object is the relative file path of the current application (not used `./`）, value can be `string`.
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  server: {
-    publicRoutes: {
-      // Set up a long route
-      'index.json': '/user-config/card-info/extra/help.json',
-
-      // Set up a route without a suffix
-      'robot.txt': '/app/authentication',
-    },
-  },
-});
-```

package/en/configure/app/server/ssr.mdx

@@ -1,38 +0,0 @@
----
-sidebar_label: ssr
----
-
-# server.ssr
-
-- **Type:** `boolean`
-- **Default:** `false`
-
-Enalbe SSR configuration.
-
-### Boolean Type
-
-When the value type is `boolean`, it indicates whether to enable SSR deployment mode, and `false` is not enabled by default.
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  server: {
-    ssr: true,
-  },
-});
-```
-
-### Object Type
-
-When the value type is `Object`, The following properties can be configured:
-
-- `mode`：`string = 'string'`, use `renderToString` rendering default. onfigure 'stream' to enable streaming rendering.
-- `forceCSR`：`boolean = false`, forced CSR rendering is disable by default. When configured as `true`, add `?csr=true` in URL to force CSR.
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  server: {
-    forceCSR: true,
-    mode: 'stream',
-  },
-});
-```

package/en/configure/app/source/alias.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: alias
----
-
-# source.alias
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [source.alias](https://modernjs.dev/builder/en/api/config-source.html#sourcealias).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/source/alias.md'
-
-<Main />

package/en/configure/app/source/compile-js-data-uri.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: compileJsDataURI
----
-
-# source.compileJsDataURI
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [source.compileJsDataURI](https://modernjs.dev/builder/en/api/config-source.html#sourcecompilejsdatauri).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/source/compileJsDataURI.md'
-
-<Main />

package/en/configure/app/source/define.mdx

@@ -1,13 +0,0 @@
----
-sidebar_label: define
----
-
-# source.define
-
-:::tip
-This config is provided by Modern.js Builder, more detail can see [source.define](https://modernjs.dev/builder/en/api/config-source.html#sourcedefine).
-:::
-
-import Main from '@modern-js/builder-doc/docs/en/config/source/define.md'
-
-<Main />