@modern-js/main-doc 2.1.0 → 2.3.0

package/en/configure/app/bff/proxy.mdx

@@ -0,0 +1,76 @@
+---
+sidebar_label: proxy
+---
+
+# bff.proxy
+
+- **Type:** `Record<string, string>`
+- **Default:** `{}`
+
+:::caution Caution
+First you need to enable the "BFF" function using [new](/apis/app/commands/new) command.
+
+:::
+
+With simple configuration, no code is required, Modern.js automatically forwards requests. Requests sent to Modern.js BFF server are proxied to the specified service.
+
+BFF Proxy uses the powerful [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware), and if you need more advanced usage, you can check its [documentation](https://github.com/chimurai/http-proxy-middleware#options).
+
+Add the following configuration to `modern.server-runtime.config.ts`, you can turn on the proxy:
+
+```ts title="modern.server-runtime.config.ts"
+import { defineConfig } from '@modern-js/app-tools/server';
+export default defineConfig({
+  bff: {
+    proxy: {
+      '/api': 'https://cnodejs.org',
+    },
+  },
+});
+```
+
+Assuming that the starting Modern.js BFF server's service address is `localhost:8080`, all requests whose path starts with `api` will be intercepted, such as requests sent to `localhost:8080/api/v1/topics` will be proxied to `https://cnodejs.org/api/v1/topics`.
+
+You can do path rewriting, such as proxying requests sent to `localhost:8080/api/topics` to `https://cnodejs.org/api/v1/topics`.
+
+```js title="modern.server-runtime.config.js"
+import { defineConfig } from '@modern-js/app-tools/server';
+export default defineConfig({
+  bff: {
+    proxy: {
+      '/api': {
+        target: 'https://cnodejs.org',
+        pathRewrite: { '/api/topics': '/api/v1/topics' },
+        changeOrigin: true,
+      },
+    },
+  },
+});
+```
+
+Unlike [dev.proxy](/configure/app/dev/proxy), the proxy described in this section only works on requests entering the BFF/API service; at the same time, this configuration can be used not only in the development environment, but also in the production environment. The corresponding request will also be proxied in the production environment.
+
+## Common usage
+
+### Solve interface cross-domain problems
+
+In the process of project development, because web pages and interface services are not deployed under the same domain name, cross-domain problems are often encountered.
+
+There are many ways to solve cross-domain problems, and here we use `bff.proxy` to easily solve cross-domain problems.
+
+:::info
+In BFF proxy mode, if you do not need to write the BFF interface, the API directory can be deleted; at this time, BFF proxy will still be enabled.
+
+:::
+
+As shown below, in the `modern.server-runtime.config.js`, write the following configuration; we send all web pages to the same domain that request proxies starting with `/api` to another domain's service.
+
+```ts title="modern.server-runtime.config.ts"
+export default defineServerConfig({
+  bff: {
+    proxy: {
+      '/api': 'https://cnodejs.org',
+    },
+  },
+};
+```

package/en/configure/app/builder-plugins.mdx

@@ -0,0 +1,71 @@
+---
+title: builderPlugins
+sidebar_position: 10
+---
+# builderPlugins
+
+- **Type:** `BuilderPlugin[]`
+- **Default:** `[]`
+
+Used to configure the Modern.js Builder plugin.
+
+Modern.js Builder is the build engine of Modern.js, please read [Builder](/guides/basic-features/builder) for background. If you want to know how to write Builder plugins, you can refer to [Modern.js Builder - Introduce to Plugin](https://modernjs.dev/builder/en/plugins/introduction.html).
+
+## Precautions
+
+This option **is used to configure the Modern.js Builder plugins**. If you need to configure other types of plugins, please select the corresponding configs:
+
+- Use [plugins](docs/configure/app/builder-plugins) to configure Modern.js framework plugins.
+- Use [tools.webpack](/configure/app/tools/webpack) or [tools.webpackChain](/configure/app/tools/webpack-chain) to configure webpack plugins.
+- Use [tools.babel](/configure/app/tools/babel) to configure babel plugins.
+
+## When to use
+
+In most scenarios, we recommend you to use the Modern.js framework plugin, which can be registered through the [plugins](docs/configure/app/plugins) config. Because the API provided by the framework plugin is richer and more capable, while the API provided by the Builder plugin can only be used to build scenes.
+
+When you need to reference some existing Builder plugins (and there is no related capability in Modern.js), or reuse Builder plugins between different frameworks, you can use the `builderPlugins` field to register them.
+
+## Example
+
+Below is an example of using the Builder plugin.
+
+### Using plugins on npm
+
+To use a plugin on npm, you need to install the plugin through the package manager and import it.
+
+```ts title="modern.config.ts"
+import myBuilderPlugin from 'my-builder-plugin';
+
+export default defineConfig({
+  builderPlugins: [myBuilderPlugin()],
+});
+```
+
+### Using local plugins
+
+Use the plugin in the local code repository, you can import it directly through the relative path import.
+
+```ts title="modern.config.ts"
+import myBuilderPlugin from './plugin/myBuilderPlugin';
+
+export default defineConfig({
+  builderPlugins: [myBuilderPlugin()],
+});
+```
+
+### Plugin configuration items
+
+If the plugin provides some custom configuration options, you can pass in the configuration through the parameters of the plugin function.
+
+```ts title="modern.config.ts"
+import myBuilderPlugin from 'my-builder-plugin';
+
+export default defineConfig({
+  builderPlugins: [
+    myBuilderPlugin({
+      foo: 1,
+      bar: 2,
+    }),
+  ],
+});
+```

package/en/configure/app/deploy/microFrontend.mdx

@@ -0,0 +1,53 @@
+---
+sidebar_label: microFrontend
+---
+
+# deploy.microFrontend
+
+- **Type:** `object`
+- **Default:** `{ enableHtmlEntry: true, externalBasicLibrary: false }`
+
+```ts
+interface MicroFrontend {
+  enableHtmlEntry?: boolean;
+  externalBasicLibrary?: boolean;
+  moduleApp?: string;
+}
+```
+
+Developers can use the `deploy.microFrontend` to configure micro-frontend sub-application information.
+
+:::caution
+Enable the "Micro Frontend" features through `pnpm run new` first.
+
+:::
+
+## Example
+
+```ts
+export default defineConfig({
+  deploy: {
+    microFrontend: {
+      enableHtmlEntry: true,
+    },
+  },
+});
+```
+
+## Configuration
+
+### enableHtmlEntry
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+Whether to enable the html entry, the default is `true`, the sub-application is built into the `HTML` mode, Garfish supports the `html` entry, you can turn on the open option, experience the corresponding features, and directly point the sub-application entry to the HTML entry when it is the HTML entry. Just point to the html of the sub-application
+
+Set it to `false` to indicate that the sub-application is built as `js`. After the sub-application is built as `js`, it cannot run independently. When it is a `JS` entry, point the entry file of the sub-application to the `JS` of the sub-application.
+
+### externalBasicLibrary
+
+- **Type:** `boolean`
+- **Default:** `false`
+
+Whether the `external` base library, when set to `true`, the current child application will be `external`: `react`, `react-dom`, Modern.js main application will automatically `setExternal` these two base libraries, if other types of frameworks Please add `react`, `react-dom` dependencies through `Garfish.setExternal`.

package/en/configure/app/dev/asset-prefix.mdx

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

package/en/configure/app/dev/hmr.mdx

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

package/en/configure/app/dev/https.mdx

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

package/en/configure/app/dev/port.mdx

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

package/en/configure/app/dev/progress-bar.mdx

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

package/en/configure/app/dev/proxy.mdx

@@ -0,0 +1,9 @@
+---
+sidebar_label: proxy
+---
+
+# dev.proxy
+
+import GlobalProxyConfig from "@site-docs-en/components/global-proxy-config"
+
+<GlobalProxyConfig />

package/en/configure/app/dev/start-url.mdx

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

package/en/configure/app/experiments/lazy-compilation.mdx

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

package/en/configure/app/html/app-icon.mdx

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

package/en/configure/app/html/crossorigin.mdx

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

package/en/configure/app/html/disable-html-folder.mdx

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

package/en/configure/app/html/favicon-by-entries.mdx

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

package/en/configure/app/html/favicon.mdx

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

package/en/configure/app/html/inject-by-entries.mdx

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

package/en/configure/app/html/inject.mdx

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

package/en/configure/app/html/meta-by-entries.mdx

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

package/en/configure/app/html/meta.mdx

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

package/en/configure/app/html/mount-id.mdx

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

package/en/configure/app/html/tags-by-entries.mdx

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

package/en/configure/app/html/tags.mdx

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

package/en/configure/app/html/template-by-entries.mdx

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

package/en/configure/app/html/template-parameters-by-entries.mdx

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

package/en/configure/app/html/template-parameters.mdx

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

package/en/configure/app/html/template.mdx

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

package/en/configure/app/html/title-by-entries.mdx

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

package/en/configure/app/html/title.mdx

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

package/en/configure/app/output/asset-prefix.mdx

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

package/en/configure/app/output/assets-retry.mdx

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

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

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

package/en/configure/app/output/clean-dist-path.mdx

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

package/en/configure/app/output/convert-to-rem.mdx

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

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

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