@modern-js/main-doc 2.0.3-alpha.0 → 2.2.0

package/en/docusaurus-plugin-content-docs/current/configure/app/output/clean-dist-path.md

@@ -1,12 +0,0 @@
----
-title: output.cleanDistPath
-sidebar_label: cleanDistPath
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.cleanDistPath](https://modernjs.dev/builder/zh/api/config-output.html#output-cleandistpath)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/cleanDistPath.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/convert-to-rem.md

@@ -1,12 +0,0 @@
----
-title: output.convertToRem
-sidebar_label: convertToRem
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.convertToRem](https://modernjs.dev/builder/zh/api/config-output.html#output-converttorem)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/convertToRem.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/copy.md

@@ -1,12 +0,0 @@
----
-title: output.copy
-sidebar_label: copy
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.copy](https://modernjs.dev/builder/zh/api/config-output.html#output-copy)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/copy.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/css-module-local-ident-name.md

@@ -1,12 +0,0 @@
----
-title: output.cssModuleLocalIdentName
-sidebar_label: cssModuleLocalIdentName
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.cssModuleLocalIdentName](https://modernjs.dev/builder/zh/api/config-output.html#output-cssmodulelocalidentname)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/cssModuleLocalIdentName.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/data-uri-limit.md

@@ -1,12 +0,0 @@
----
-title: output.dataUriLimit
-sidebar_label: dataUriLimit
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.dataUriLimit](https://modernjs.dev/builder/zh/api/config-output.html#output-dataurilimit)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/dataUriLimit.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-css-extract.md

@@ -1,12 +0,0 @@
----
-title: output.disableCssExtract
-sidebar_label: disableCssExtract
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableCssExtract](https://modernjs.dev/builder/zh/api/config-output.html#output-disablecssextract)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableCssExtract.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-css-module-extension.md

@@ -1,12 +0,0 @@
----
-title: output.disableCssModuleExtension
-sidebar_label: disableCssModuleExtension
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableCssModuleExtension](https://modernjs.dev/builder/zh/api/config-output.html#output-disablecssmoduleextension)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableCssModuleExtension.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-filename-hash.md

@@ -1,12 +0,0 @@
----
-title: output.disableFilenameHash
-sidebar_label: disableFilenameHash
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableFilenameHash](https://modernjs.dev/builder/zh/api/config-output.html#output-disablefilenamehash)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableFilenameHash.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-inline-runtime-chunk.md

@@ -1,12 +0,0 @@
----
-title: output.disableInlineRuntimeChunk
-sidebar_label: disableInlineRuntimeChunk
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableInlineRuntimeChunk](https://modernjs.dev/builder/zh/api/config-output.html#output-disableinlineruntimechunk)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableInlineRuntimeChunk.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-minimize.md

@@ -1,12 +0,0 @@
----
-title: output.disableMinimize
-sidebar_label: disableMinimize
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableMinimize](https://modernjs.dev/builder/zh/api/config-output.html#output-disableminimize)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableMinimize.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-node-polyfill.md

@@ -1,20 +0,0 @@
----
-sidebar_label: disableNodePolyfill
----
-
-# output.disableNodePolyfill
-
-* Type: `boolean`
-* Default: `false`
-
-By default Modern.js has built-in [node polyfill removed by webpack 5](https://webpack.js.org/blog/2020-10-10-webpack-5-release/#automatic-nodejs-polyfills-removed).
-
-If you confirm that you do not need any Node Polyfill in the project, you can configure the following in `modern.config.ts` to turn off the built-in imported Node Polyfill:
-
-```typescript title="modern.config.ts"
-export default defineConfig({
-  output: {
-    disableNodePolyfill: true,
-  },
-});
-```

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-source-map.md

@@ -1,12 +0,0 @@
----
-title: output.disableSourceMap
-sidebar_label: disableSourceMap
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableSourceMap](https://modernjs.dev/builder/zh/api/config-output.html#output-disablesourcemap)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableSourceMap.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-ts-checker.md

@@ -1,12 +0,0 @@
----
-title: output.disableTsChecker
-sidebar_label: disableTsChecker
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.disableTsChecker](https://modernjs.dev/builder/zh/api/config-output.html#output-disabletschecker)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/disableTsChecker.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/dist-path.md

@@ -1,12 +0,0 @@
----
-title: output.distPath
-sidebar_label: distPath
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.distPath](https://modernjs.dev/builder/zh/api/config-output.html#output-distpath)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/distPath.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-asset-fallback.md

@@ -1,12 +0,0 @@
----
-title: output.enableAssetFallback
-sidebar_label: enableAssetFallback
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.enableAssetFallback](https://modernjs.dev/builder/zh/api/config-output.html#output-enableassetfallback)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/enableAssetFallback.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-asset-manifest.md

@@ -1,12 +0,0 @@
----
-title: output.enableAssetManifest
-sidebar_label: enableAssetManifest
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.enableAssetManifest](https://modernjs.dev/builder/zh/api/config-output.html#output-enableassetmanifest)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/enableAssetManifest.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-css-module-tsdeclaration.md

@@ -1,12 +0,0 @@
----
-title: output.enableCssModuleTSDeclaration
-sidebar_label: enableCssModuleTSDeclaration
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.enableCssModuleTSDeclaration](https://modernjs.dev/builder/zh/api/config-output.html#output-enablecssmoduletsdeclaration)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/enableCssModuleTSDeclaration.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-inline-scripts.md

@@ -1,12 +0,0 @@
----
-title: output.enableInlineScripts
-sidebar_label: enableInlineScripts
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.enableInlineScripts](https://modernjs.dev/builder/zh/api/config-output.html#output-enableinlinescripts)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/enableInlineScripts.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-inline-styles.md

@@ -1,12 +0,0 @@
----
-title: output.enableInlineStyles
-sidebar_label: enableInlineStyles
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.enableInlineStyles](https://modernjs.dev/builder/zh/api/config-output.html#output-enableinlinestyles)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/enableInlineStyles.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-latest-decorators.md

@@ -1,12 +0,0 @@
----
-title: output.enableLatestDecorators
-sidebar_label: enableLatestDecorators
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.enableLatestDecorators](https://modernjs.dev/builder/zh/api/config-output.html#output-enablelatestdecorators)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/enableLatestDecorators.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/externals.md

@@ -1,12 +0,0 @@
----
-title: output.externals
-sidebar_label: externals
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.externals](https://modernjs.dev/builder/zh/api/config-output.html#output-externals)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/externals.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/filename.md

@@ -1,12 +0,0 @@
----
-title: output.filename
-sidebar_label: filename
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.filename](https://modernjs.dev/builder/zh/api/config-output.html#output-filename)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/filename.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/legal-comments.md

@@ -1,12 +0,0 @@
----
-title: output.legalComments
-sidebar_label: legalComments
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.legalComments](https://modernjs.dev/builder/zh/api/config-output.html#output-legalcomments)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/legalComments.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/override-browserslist.md

@@ -1,12 +0,0 @@
----
-title: output.overrideBrowserslist
-sidebar_label: overrideBrowserslist
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.overrideBrowserslist](https://modernjs.dev/builder/zh/api/config-output.html#output-overridebrowserslist)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/overrideBrowserslist.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/polyfill.md

@@ -1,12 +0,0 @@
----
-title: output.polyfill
-sidebar_label: polyfill
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.polyfill](https://modernjs.dev/builder/zh/api/config-output.html#output-polyfill)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/polyfill.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/output/ssg.md

@@ -1,226 +0,0 @@
----
-sidebar_label: ssg
----
-# output.ssg
-
-* 类型： `boolean` | `object` | `function`
-* 默认值： `undefined`
-
-Enable the SSG for **Self-controlled Routing** or **Conventional Routing**.
-
-:::info
-For more routes detail, see [routes](/docs/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**:
-
-```tsx title="App.tsx"
-import { useRuntimeContext } from '@modern-js/runtime';
-import { Routes, Route, BrowserRouter } from '@modern-js/runtime/router';
-import { StaticRouter } from '@modern-js/runtime/router/server';
-
-const Router = typeof window === 'undefined' ? StaticRouter : BrowserRouter;
-
-export default () => {
-  const { context } = useRuntimeContext();
-  return (
-    <Router location={context.request.pathname}>
-      <Routes>
-        <Route index element={<div>index</div>} />
-        <Route path="about" element={<div>about</div>} />
-      </Routes>
-    </Router>
-  );
-};
-```
-
-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:
-
-```tsx title="src/App.tsx"
-import { useRuntimeContext } from '@modern-js/runtime';
-import { Routes, Route, BrowserRouter } from '@modern-js/runtime/router';
-import { StaticRouter } from '@modern-js/runtime/router/server';
-
-const Router = typeof window === 'undefined' ? StaticRouter : BrowserRouter;
-
-export default () => {
-  const { context } = useRuntimeContext();
-  return (
-    <Router location={context.request.pathname}>
-      <Routes>
-        <Route index element={<div>index</div>} />
-        <Route path="about" element={<div>about</div>} />
-      </Routes>
-    </Router>
-  );
-};
-```
-
-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/docusaurus-plugin-content-docs/current/configure/app/output/svg-default-export.md

@@ -1,12 +0,0 @@
----
-title: output.svgDefaultExport
-sidebar_label: svgDefaultExport
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [output.svgDefaultExport](https://modernjs.dev/builder/zh/api/config-output.html#output-svgdefaultexport)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/output/svgDefaultExport.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/performance/build-cache.md

@@ -1,12 +0,0 @@
----
-title: performance.buildCache
-sidebar_label: buildCache
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [performance.buildCache](https://modernjs.dev/builder/zh/api/config-performance.html#performance-buildcache)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/performance/buildCache.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/performance/bundle-analyze.md

@@ -1,12 +0,0 @@
----
-title: performance.bundleAnalyze
-sidebar_label: bundleAnalyze
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [performance.bundleAnalyze](https://modernjs.dev/builder/zh/api/config-performance.html#performance-bundleanalyze)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/performance/bundleAnalyze.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/performance/chunk-split.md

@@ -1,12 +0,0 @@
----
-title: performance.chunkSplit
-sidebar_label: chunkSplit
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [performance.chunkSplit](https://modernjs.dev/builder/zh/api/config-performance.html#performance-chunksplit)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/performance/chunkSplit.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/performance/print-file-size.md

@@ -1,12 +0,0 @@
----
-title: performance.printFileSize
-sidebar_label: printFileSize
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [performance.printFileSize](https://modernjs.dev/builder/zh/api/config-performance.html#performance-printfilesize)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/performance/printFileSize.md'
-
-<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/performance/profile.md

@@ -1,12 +0,0 @@
----
-title: performance.profile
-sidebar_label: profile
----
-
-:::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [performance.profile](https://modernjs.dev/builder/zh/api/config-performance.html#performance-profile)。
-:::
-
-import Main from '@modern-js/builder-doc/en/config/performance/profile.md'
-
-<Main />