npm - @modern-js/main-doc - Versions diffs - 2.0.0-beta.0 → 2.0.0-beta.1 - Mend

@modern-js/main-doc 2.0.0-beta.0 → 2.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (507) hide show

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/dev/progress-bar.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: dev.progressBar
 sidebar_label: progressBar
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/docusaurus-plugin-content-docs/current/configure/app/dev/proxy.md ADDED Viewed

@@ -0,0 +1,80 @@
+---
+sidebar_label: proxy
+---
+# dev.proxy
+* Type: `string | Object`
+* Default: `null`
+When this option is configured, the development environment will start a global proxy, similar to [Fiddler](https://www.telerik.com/fiddler), [Charles](https://www.charlesproxy.com/) and other web proxy debugging tools, which can be used to view, modify HTTP/HTTPS requests, responses, and can also be used as a proxy server.
+:::tip 提示
+Using this option requires advance installation `@modern-js/plugin-proxy`。
+:::
+### Object
+Using this option requires that the value of `Object` be installed in advance, the `key` of the object corresponds to the matching `pattern`, and the `value` of the object corresponds to the matching `target`.
+Example:
+```typescript title="modern.config.ts"
+export default defineConfig({
+  dev: {
+    proxy: {
+      'https://www.baidu.com': 'https://google.com.hk',
+      //可以通过 file 协议直接返回静态文件。
+      'https://example.com/api': 'file://./data.json',
+    }
+  }
+});
+```
+### String
+When the value is `string`, it can be used to specify a separate proxy file, for example:
+```typescript title="modern.config.ts"
+export default defineConfig({
+  dev: {
+    proxy: './proxy.js',
+  },
+});
+```
+```js title="proxy.js"
+module.exports = {
+  name: 'my-app',
+  rules: `
+    ^example.com:8080/api/***   http://localhost:3001/api/$
+  `,
+};
+```
+:::info
+Modern.js global proxy implementation is based on [whistle](https://wproxy.org/whistle/), for more matching patterns, please refer to: [Matching Patterns](https://wproxy.org/whistle/pattern.html)
+:::
+Execute `dev`, when the prompt is as follows, the proxy server starts successfully:
+```bash
+  App running at:
+  Local:    http://localhost:8080/
+  Network:  http://192.168.0.1:8080/
+ℹ  info      Starting the proxy server.....
+✔  success   Proxy Server start on localhost:8899
+```
+Access the `localhost:8899` to view the Network and configure proxy rules on the UI interface:
+![proxy UI](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/dev-proxy.png)
+:::caution Caution
+The https agent automatically installs the certificate to obtain root privileges. Please enter the password as prompted. ** The password is only used when the certificate is trusted and will not be leaked or used for other links **.
+:::

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/dev/start-url.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: dev.startUrl
 sidebar_label: startUrl
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/docusaurus-plugin-content-docs/current/configure/app/dev/with-master-app.md ADDED Viewed

@@ -0,0 +1,32 @@
+---
+sidebar_label: withMasterApp
+---
+# dev.withMasterApp
+* Type: `Object`
+* Default: `null`
+When the project is a micro-front-end sub-application, you can use the `withMasterApp` configuration to enable the sub-application debugging mode.
+:::caution Caution
+When using child app debugging mode, you should first ensure that the main app has online debugging mode turned on.
+:::
+```js title=modern.config.js
+export default defineConfig({
+  dev: {
+    withMasterApp: {
+      //the path of the main application
+      moduleApp: 'https://www.masterApp.com',
+      //name of the subapplication
+      moduleName: 'Contact'
+    }
+  }
+})
+```
+- moduleApp: `string` Online address of the main application.
+- moduleName: `Contact` The name of the child app (needs to match the module name registered in the main app)。
+For detailed usage, please refer to [Micro Front-end Sub-Application](/docs/guides/topic-detail/micro-frontend/debugging)。

package/en/docusaurus-plugin-content-docs/current/configure/app/experiments/lazy-compilation.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+title: experiments.lazyCompilation
+sidebar_label: lazyCompilation
+---
+:::info BUILDER
+This configuration is Modern.js Builder configuration, there may be links that cannot be redirected. for details, please refer to [experiments.lazyCompilation](https://modernjs.dev/builder/zh/api/config-experiments.html#experiments-lazycompilation)。
+:::
+import Main from '@modern-js/builder-doc/en/config/experiments/lazyCompilation.md'
+<Main />

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/app-icon.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.appIcon
 sidebar_label: appIcon
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/crossorigin.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.crossorigin
 sidebar_label: crossorigin
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/disable-html-folder.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.disableHtmlFolder
 sidebar_label: disableHtmlFolder
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/favicon-by-entries.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.faviconByEntries
 sidebar_label: faviconByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/favicon.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.favicon
 sidebar_label: favicon
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/inject-by-entries.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.injectByEntries
 sidebar_label: injectByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/inject.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.inject
 sidebar_label: inject
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/meta-by-entries.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.metaByEntries
 sidebar_label: metaByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/meta.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.meta
 sidebar_label: meta
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/mount-id.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.mountId
 sidebar_label: mountId
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/template-by-entries.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.templateByEntries
 sidebar_label: templateByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/template-parameters-by-entries.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.templateParametersByEntries
 sidebar_label: templateParametersByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/template-parameters.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.templateParameters
 sidebar_label: templateParameters
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/template.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.template
 sidebar_label: template
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/title-by-entries.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.titleByEntries
 sidebar_label: titleByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/html/title.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.title
 sidebar_label: title
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/asset-prefix.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.assetPrefix
 sidebar_label: assetPrefix
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/assets-retry.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.assetsRetry
 sidebar_label: assetsRetry
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/charset.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.charset
 sidebar_label: charset
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/clean-dist-path.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.cleanDistPath
 sidebar_label: cleanDistPath
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/convert-to-rem.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.convertToRem
 sidebar_label: convertToRem
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/copy.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.copy
 sidebar_label: copy
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/css-module-local-ident-name.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.cssModuleLocalIdentName
 sidebar_label: cssModuleLocalIdentName
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/data-uri-limit.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.dataUriLimit
 sidebar_label: dataUriLimit
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/disable-css-module-extension.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableCssModuleExtension
 sidebar_label: disableCssModuleExtension
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/disable-filename-hash.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableFilenameHash
 sidebar_label: disableFilenameHash
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/disable-inline-runtime-chunk.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableInlineRuntimeChunk
 sidebar_label: disableInlineRuntimeChunk
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/disable-minimize.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableMinimize
 sidebar_label: disableMinimize
-sidebar_position: 1
 ---
 :::info BUILDER

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

@@ -0,0 +1,20 @@
+---
+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/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/disable-source-map.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableSourceMap
 sidebar_label: disableSourceMap
-sidebar_position: 1
 ---
 :::info BUILDER

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

@@ -0,0 +1,12 @@
+---
+title: output.disableTsChecker
+sidebar_label: disableTsChecker
+---
+:::info BUILDER
+This configuration is Modern.js Builder configuration, there may be links that cannot be redirected. for details, please refer to [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/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/dist-path.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.distPath
 sidebar_label: distPath
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/enable-asset-fallback.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableAssetFallback
 sidebar_label: enableAssetFallback
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/enable-asset-manifest.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableAssetManifest
 sidebar_label: enableAssetManifest
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/enable-css-module-tsdeclaration.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableCssModuleTSDeclaration
 sidebar_label: enableCssModuleTSDeclaration
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/enable-inline-scripts.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableInlineScripts
 sidebar_label: enableInlineScripts
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/enable-inline-styles.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableInlineStyles
 sidebar_label: enableInlineStyles
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/{configure → docusaurus-plugin-content-docs/current/configure}/app/output/enable-latest-decorators.md RENAMED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableLatestDecorators
 sidebar_label: enableLatestDecorators
-sidebar_position: 1
 ---
 :::info BUILDER

package/en/docusaurus-plugin-content-docs/current/configure/app/output/enable-modern-mode.md ADDED Viewed

@@ -0,0 +1,34 @@
+---
+sidebar_label: enableModernMode
+---
+# output.enableModernMode
+* Type: `boolean`
+* Default: `false`
+Modern.js default value to build JS products with Polyfill for older browsers. After opening this configuration, you can automatically build JS products that are not degraded for modern browser syntax in the production environment. The product filename format is `[name].[hash]-es6/js`.
+For example, configure the following configuration:
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+export default defineConfig({
+  output: {
+    enableModernMode: true,
+  },
+});
+```
+After executing the `build` command, modern is packaged in addition to the normal Client packaging, and the `dist/static/js` directory will generate es6 related products.
+![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/output-enable-modern-build.jpeg)
+After executing the `start` command, use the latest version Chrome browser access, and observe that the requested JS resource in the Network is an es6 product.
+![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/output-enable-modern-network.jpeg)
+:::info
+For more information, see [Client side compatibility](/docs/guides/advanced-features/compatibility)。
+:::