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

package/en/docusaurus-plugin-content-docs/current/configure/app/runtime/state.md

@@ -4,8 +4,8 @@ sidebar_label: state
 
 # runtime.state
 
-* Type:`boolean | object`
-* Default: `false`
+- Type:`boolean | object`
+- Default: `false`
 
 Once `state` is enabled, you can use [Model](/docs/guides/topic-detail/model/quick-start) for state management.
 
@@ -13,42 +13,42 @@ The specific configuration items are as follows:
 
 ## models
 
-* Type：`Array<Model>`
-* Default：`[]`
+- Type：`Array<Model>`
+- Default：`[]`
 
 Register model objects that are mounted in advance, and these models will be mounted immediately after the Reduck store is created. Generally, there is no need to mount in advance.
 
 ## initialState
-* Type: `Object`
-* Default：`{}`
+
+- Type: `Object`
+- Default：`{}`
 
 Used to set the initial state of the global store. Generally used for SSR to initialize data during the hydration phase.
 
 ## immer
 
-* Type:`boolean`
-* Default: `true`
+- Type:`boolean`
+- Default: `true`
 
 Whether to enable to update the state with mutable, it is enabled by default, and set to `false` if you want to disable it.
 
 ## effects
 
-* Type:`boolean`
-* Default: `true`
+- Type:`boolean`
+- Default: `true`
 
 Whether to enable the side effect management feature, it is enabled by default, and set to `false` if you want to disable it.
 
 ## autoActions
 
-* Type:`boolean`
-* Default: `true`
+- Type:`boolean`
+- Default: `true`
 
 Whether to enable the auto-generated actions feature, it is enabled by default, and set to `false` if you want to disable it.
 
-
 ## devtools
 
-* Type:`boolean | EnhancerOptions`
-* Default: `true`
+- Type:`boolean | EnhancerOptions`
+- Default: `true`
 
 Whether to enable devtools, it is enabled by default, and all parameters of [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md) are supported at the same time. If you want to disable it, set it to `false`.

package/en/docusaurus-plugin-content-docs/current/configure/app/security/sri.md

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

package/en/docusaurus-plugin-content-docs/current/configure/app/server/base-url.md

@@ -4,13 +4,12 @@ sidebar_label: baseUrl
 
 # server.baseUrl
 
-* Type: `string | string[]`
-* Default: `undefined`
-
+- Type: `string | string[]`
+- Default: `undefined`
 
 Uniformly set the server-level routing prefix (often used in the case of shared domain names to distinguish traffic).
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     // 所有生成的路由前面都会自动加上前缀 `/base`

package/en/docusaurus-plugin-content-docs/current/configure/app/server/enable-framework-ext.md

@@ -1,20 +1,21 @@
 ---
 sidebar_label: enableFrameworkExt
 ---
+
 # server.enableFrameworkExt
 
-* 类型： `Boolean`
-* 默认值： `false`
+- Type: `boolean`
+- Default: `false`
 
 By default, with 【Custom Web Server](/docs/guides/advanced-features/web-server) enable, Middleware uses the syntax of the Modern.js itself.
 
 Enable `server.enableFrameworkExt` to use the syntax of framework extensions.
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     enableFrameworkExt: true,
-  }
+  },
 });
 ```
 

package/en/docusaurus-plugin-content-docs/current/configure/app/server/port.md

@@ -4,15 +4,35 @@ sidebar_label: port
 
 # server.port
 
-* Type: `Number`
-* Default: `8080`
+- Type: `number`
+- Default: `8080`
 
-Modern.js' default port is '8080', when using the `dev` or `start` command. You can change the port number using this configuration:
+When Modern.js executes `dev`, `start` and `serve` commands, it will start with `8080` as the default port, and will automatically increment the port number when the port is occupied. You can change the port number of Server through this config:
 
 ```js title="modern.config.ts"
 export default defineConfig({
   server: {
     port: 3000,
-  }
+  },
+});
+```
+
+### Difference with dev.port
+
+In most cases, we recommend using `server.port` instead of `dev.port` to set the port number, the differences between them are as follows:
+
+- `dev.port` only takes effect in the development, and `server.port` takes effect in both development and production.
+- In the development, `dev.port` takes precedence over `server.port`.
+
+When you set `dev.port` and `server.port` at the same time, `dev.port` will take effect in the development, and `server.port` will take effect in the production. For example, in the following example, the port in the development is `3001`, and the port in the production is `3002`.
+
+```ts title="modern.config.ts"
+export default defineConfig({
+  dev: {
+    port: 3001,
+  },
+  server: {
+    port: 3002,
+  },
 });
 ```

package/en/docusaurus-plugin-content-docs/current/configure/app/server/public-routes.md

@@ -4,14 +4,14 @@ 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.
+- 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`.
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     publicRoutes: {
@@ -19,8 +19,8 @@ export default defineConfig({
       'index.json': '/user-config/card-info/extra/help.json',
 
       // Set up a route without a suffix
-      'robot.txt': '/app/authentication'
-    }
-  }
+      'robot.txt': '/app/authentication',
+    },
+  },
 });
 ```

package/en/docusaurus-plugin-content-docs/current/configure/app/server/routes.md

@@ -4,8 +4,8 @@ sidebar_label: routes
 
 # server.routes
 
-* Type: `Object`
-* Default: Automatic generation of server-level routing rules based on file conventions: One routing rule is generated per file of the application,and the default route is the same as the entry name.
+- Type: `Object`
+- Default: Automatic generation of server-level routing rules based on file conventions: One routing rule is generated per file of the application,and the default route is the same as the entry name.
 
 This configuration option only applies to server-level routing, and can customize the service access configuration of the application entry.
 
@@ -13,9 +13,9 @@ This configuration option only applies to server-level routing, and can customiz
 
 The `key` of the object is the entry name of the current application, and the value can be `string | Array<string>`.
 
-When the value type is  `string`, the current value represents the name of the route to access the entry.
+When the value type is `string`, the current value represents the name of the route to access the entry.
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     routes: {
@@ -30,7 +30,7 @@ export default defineConfig({
 
 Multiple access routes can also be set for entries using the `Array<string>`:
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     routes: {
@@ -60,7 +60,7 @@ After executing the `dev` command, you can see in `dist/route.json` that there a
       "entryPath": "html/page-a/index.html",
       "isSPA": true,
       "isSSR": false
-    },
+    }
   ]
 }
 ```
@@ -69,7 +69,7 @@ After executing the `dev` command, you can see in `dist/route.json` that there a
 
 The response header can be set by configuring the resHeaders of the entry:
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     routes: {

package/en/docusaurus-plugin-content-docs/current/configure/app/server/ssr-by-entries.md

@@ -4,8 +4,8 @@ sidebar_label: ssrByEntries
 
 # server.ssrByEntries
 
-* Type: `Object`
-* Default: `undefined`
+- Type: `Object`
+- Default: `undefined`
 
 Set the ssr option according to the entry. The attributes in the option are the same as [ssr](./ssr.md). The specified value will be replaced and merged with the content of the ssr attribute. For example:
 
@@ -13,15 +13,15 @@ Set the ssr option according to the entry. The attributes in the option are the
 The "entry name" defaults to the directory name. In a few cases, when the entry is customized by `source.entries`, the entry name `source.entries` the `key` of the object.
 :::
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     ssr: true,
     ssrByEntries: {
       // page-a does not enable ssr
       'page-a': false,
-    }
-  }
+    },
+  },
 });
 ```
 

package/en/docusaurus-plugin-content-docs/current/configure/app/server/ssr.md

@@ -4,17 +4,17 @@ sidebar_label: ssr
 
 # server.ssr
 
-* Type: `boolean`
-* Default: `false`
+- Type: `boolean`
+- Default: `false`
 
 Enalbe SSR configuration.
 
 When the value type is `boolean`, it indicates whether to enable SSR deployment mode, and `false` is not enabled by default.
 
-```typescript title="modern.config.ts"
+```ts title="modern.config.ts"
 export default defineConfig({
   server: {
     ssr: true,
-  }
+  },
 });
 ```

package/en/docusaurus-plugin-content-docs/current/configure/app/source/alias.md

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

package/en/docusaurus-plugin-content-docs/current/configure/app/source/compile-js-data-uri.md

@@ -4,9 +4,9 @@ sidebar_label: compileJsDataURI
 ---
 
 :::info BUILDER
-This configuration is Modern.js Builder configuration, more detail can see [source.compileJsDataURI](https://modernjs.dev/builder/zh/api/config-source.html#source-compilejsdatauri)。
+This configuration is Modern.js Builder configuration, more detail can see [source.compileJsDataURI](https://modernjs.dev/builder/en/api/config-source.html#source-compilejsdatauri)。
 :::
 
-import Main from '@modern-js/builder-doc/en/config/source/compileJsDataURI.md'
+import Main from '@modern-js/builder-doc/docs/en/config/source/compileJsDataURI.md'
 
 <Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/source/config-dir.md

@@ -3,8 +3,8 @@ title: source.configDir
 sidebar_label: configDir
 ---
 
-* Type: `string`
-* Default: `./config`
+- Type: `string`
+- Default: `./config`
 
 Modern.js supports placing some files in the `./config` folder to customize HTML templates, icons, static resources, etc. For details, please refer to [File Convention](/docs/apis/app/hooks/config/html).
 

package/en/docusaurus-plugin-content-docs/current/configure/app/source/define.md

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