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

package/zh/configure/app/runtime/state.md

@@ -1,14 +1,11 @@
 ---
 sidebar_label: state
-sidebar_position: 2
 ---
 
 # runtime.state
 
-
-
-- 类型：`boolean | object`
-- 默认值：`false`
+* 类型：`boolean | object`
+* 默认值：`false`
 
 开启 `state` 后就可以使用 [Model](/docs/guides/topic-detail/model/quick-start) 来做状态管理。
 
@@ -17,29 +14,29 @@ sidebar_position: 2
 
 ## `immer`
 
-- 类型：`boolean`
-- 默认值：`true`
+* 类型：`boolean`
+* 默认值：`true`
 
 是否启用以 mutable 更新 state 的方式，默认启用，若想禁用则设置为 `false`。
 
 ## `effects`
 
-- 类型：`boolean`
-- 默认值：`true`
+* 类型：`boolean`
+* 默认值：`true`
 
 是否启用副作用管理特性，默认启用，若想禁用则设置为 `false`。
 
 ## `autoActions`
 
-- 类型：`boolean`
-- 默认值：`true`
+* 类型：`boolean`
+* 默认值：`true`
 
 是否启用自动生成 actions 特性，默认启用，若想禁用则设置为 `false`。
 
 
 ## `devtools`
 
-- 类型：`boolean | EnhancerOptions`
-- 默认值：`true`
+* 类型：`boolean | EnhancerOptions`
+* 默认值：`true`
 
 是否启用 devtools，默认启用，同时支持 [redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md) 的所有参数，若想禁用则设置为 `false`。

package/zh/configure/app/security/sri.md

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

package/zh/configure/app/server/base-url.md

@@ -1,6 +1,5 @@
 ---
 sidebar_label: baseUrl
-sidebar_position: 3
 ---
 
 # server.baseUrl
@@ -13,7 +12,7 @@ sidebar_position: 3
 
 统一设置服务端路由前缀（常用于共享域名的情况，区分流量)。
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     // 所有生成的路由前面都会自动加上前缀 `/base`

package/zh/configure/app/server/port.md

@@ -1,6 +1,5 @@
 ---
 sidebar_label: port
-sidebar_position: 5
 ---
 
 # server.port
@@ -12,7 +11,7 @@ sidebar_position: 5
 
 Modern.js 在 `dev` 和  `start` 时会以 `8080` 为默认端口启动，通过该配置可以修改 Server 启动的端口号:
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     port: 3000,

package/zh/configure/app/server/public-routes.md

@@ -1,6 +1,5 @@
 ---
 sidebar_label: publicRoutes
-sidebar_position: 4
 ---
 
 # server.publicRoutes
@@ -14,7 +13,7 @@ sidebar_position: 4
 
 对象的 `key` 为当前应用的相对文件路径（不使用 `./`）, 值可以是 `string`。
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     publicRoutes: {

package/zh/configure/app/server/routes.md

@@ -1,6 +1,5 @@
 ---
 sidebar_label: routes
-sidebar_position: 4
 ---
 
 # server.routes
@@ -16,7 +15,7 @@ sidebar_position: 4
 
 当值类型为 `string` 时，当前值即表示访问该入口的路由名称。
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     routes: {
@@ -31,7 +30,7 @@ export default defineConfig({
 
 也可以通过 `Array<string>` 为入口设置多个访问路由:
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     routes: {
@@ -72,7 +71,7 @@ export default defineConfig({
 
 可以通过配置入口的 resHeaders 设置响应头：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     routes: {
@@ -88,5 +87,5 @@ export default defineConfig({
 ```
 
 :::note
-这一配置在生产环境与开发环境都生效，可以根据 NODE_ENV 区分环境设置不同的响应头。但如果你只需要在开发环境设置响应头，推荐使用 tools.devServer.headers。
+这一配置在生产环境与开发环境都生效，可以根据 NODE_ENV 区分环境设置不同的响应头。但如果你只需要在开发环境设置响应头，推荐使用 `tools.devServer.headers`。
 :::

package/zh/configure/app/server/ssr-by-entries.md

@@ -1,6 +1,5 @@
 ---
 sidebar_label: ssrByEntries
-sidebar_position: 2
 ---
 
 # server.ssrByEntries
@@ -16,12 +15,12 @@ sidebar_position: 2
 「 入口名 」默认为目录名，少数情况下通过 `source.entries` 自定义入口时，入口名为 `source.entries` 对象的 `key`。
 :::
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     ssr: true,
     ssrByEntries: {
-      // entry1 不启用 ssr
+      // page-a 不启用 ssr
       'page-a': false,
     }
   }

package/zh/configure/app/server/ssr.md

@@ -1,6 +1,5 @@
 ---
 sidebar_label: ssr
-sidebar_position: 1
 ---
 
 # server.ssr
@@ -14,7 +13,7 @@ SSR 开关以及相关设置。
 
 当值类型为 `boolean` 时，表示是否开启 SSR 部署模式，默认 `false` 不开启。
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   server: {
     ssr: true,

package/zh/configure/app/source/alias.md

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

package/zh/configure/app/source/compile-js-data-uri.md

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

package/zh/configure/app/source/config-dir.md

@@ -3,13 +3,21 @@ title: source.configDir
 sidebar_label: configDir
 ---
 
-
-
 * 类型： `string`
 * 默认值： `./config`
 
-Modern.js 支持在 `./config` 文件夹下放置一些文件自定义 HTML 模板、图标、静态资源等。
+Modern.js 支持在 `./config` 文件夹下放置一些文件自定义 HTML 模板、图标、静态资源等，具体可参考[文件约定](/docs/apis/app/hooks/config/html)。
 
 通过该选项可以自定义配置文件的目录。
 
-<!-- TODO: 文件约定 config/html 和 config/public -->
+例如，将资源文件目录调整为 `resources` 目录：
+
+```js title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  source: {
+    configDir: './resources',
+  },
+});
+```

package/zh/configure/app/source/define.md

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

package/zh/configure/app/source/design-system.md

@@ -3,15 +3,13 @@ title: source.designSystem
 sidebar_label: designSystem
 ---
 
+* 类型： `Object`
+* 默认值：见下方配置详情。
 
 :::caution 注意
 需要先通过 `pnpm run new` 启用 Tailwind CSS 功能。
 :::
 
-
-* 类型： `Object`
-* 默认值：见下方配置详情。
-
 <details>
   <summary>designSystem 配置详情</summary>
 
@@ -643,7 +641,7 @@ sidebar_label: designSystem
 </details>
 
 
-`designSystem` 用于定义项目的调色板、排版比例（Typographic Scales 或者 Type Scale）、字体列表、断点、边框圆角值等等。因为 Modern.js 借用了 Tailwind Theme 的设计方式，并且内部也集成了 Tailwind CSS，所以 `designSystem` 使用方式与 Tailwind CSS Theme 相同
+`designSystem` 用于定义项目的调色板、排版比例（Typographic Scales 或者 Type Scale）、字体列表、断点、边框圆角值等等。因为 Modern.js 借用了 Tailwind Theme 的设计方式，并且内部也集成了 Tailwind CSS，所以 `designSystem` 使用方式与 Tailwind CSS Theme 相同。
 
 ### 结构
 
@@ -651,7 +649,7 @@ sidebar_label: designSystem
 
 #### Screens
 
-使用`screens` 可以自定义项目中的响应断点：
+使用 `screens` 可以自定义项目中的响应断点：
 
 ```js
 const designSystem = {
@@ -921,7 +919,7 @@ const designSystem = {
 };
 ```
 
-**属性名确定所生成类的后缀，值确定实际CSS声明的值。**上面的示例`borderRadius`配置将生成以下CSS类：
+**属性名确定所生成类的后缀，值确定实际CSS声明的值。**上面的示例 `borderRadius` 配置将生成以下CSS类：
 
 ```css
 .rounded-none { border-radius: 0 }
@@ -943,7 +941,7 @@ const designSystem = {
 
 要覆盖默认配置中的选项，请在 `designSystem` 中添加要覆盖的属性：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 const designSystem = {
   // Replaces all of the default `opacity` values
   opacity: {
@@ -973,7 +971,7 @@ export default defineConfig({
 
 例如，如果您想添加一个额外的断点但保留现有的断点，则可以扩展 `screens` 属性：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 const designSystem = {
   extend: {
     // Adds a new breakpoint in addition to the default breakpoints
@@ -992,7 +990,7 @@ export default defineConfig({
 
 您当然可以覆盖默认主题的某些部分，并在同一配置中扩展默认主题的其他部分：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 const designSystem = {
   opacity: {
     0: '0',
@@ -1022,7 +1020,7 @@ export default defineConfig({
 
 例如，您可以在 `fill` 配置上通过引用 `theme('colors')` 为调色板中的每种颜色生成 `fill` utilities。
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 const designSystem = {
   colors: {
     // ...
@@ -1043,7 +1041,7 @@ export default defineConfig({
 
 如果出于任何原因想要引用默认配置中的值，则可以从 `tailwindcss/defaultTheme` 导入它。一个有用的示例是，如果要将添加默认配置提供的字体中某一个字体：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 const defaultTheme = require('tailwindcss/defaultTheme');
 
 const designSystem = {
@@ -1082,7 +1080,7 @@ const designSyttem = {
 
 最终结果是相同的，但是由于许多核心插件未公开任何配置，因此无论如何只能使用 corePlugins 禁用它们，最好保持一致。
 
-#### 添加自己的key
+#### 添加自己的 key
 
 在很多情况下，将自己的属性添加到配置对象可能会很有用。
 
@@ -1108,7 +1106,7 @@ const designSystem = {
 
 另一个示例是在自定义插件中添加新的属性以进行引用。例如，如果您为项目编写了渐变插件，则可以向该插件引用的主题对象添加渐变属性：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 const designSystem = {
   gradients: theme => ({
     'blue-green': [theme('colors.blue.500'), theme('colors.green.500')],
@@ -1143,14 +1141,6 @@ export default defineConfig({
 
 #### source.designSystem.supportStyledComponents
 
-##### 类型
-
-`boolean`
-
-##### 默认值
-
-`false`
-
-##### 说明
+该配置类型为 `boolean`，默认为 `false`。
 
-值 `true` 时，运行时在应用外层提供 `styled-components` `ThemeProvider` 组件，并且将通过 `designSystem` 生成的 `Theme Token` 对象注入。
+当该配置值为 `true` 时，运行时在应用外层提供 `styled-components` `ThemeProvider` 组件，并且将通过 `designSystem` 生成的 `Theme Token` 对象注入。

package/zh/configure/app/source/disable-default-entries.md

@@ -3,18 +3,23 @@ title: source.disableDefaultEntries
 sidebar_label: disableDefaultEntries
 ---
 
-- 类型： `boolean`
-- 默认值： `false`
+* 类型： `boolean`
+* 默认值： `false`
 
 关闭根据项目目录结构自动识别应用构建入口的功能，默认情况下，Modern.js 会根据项目目录结构得到对应构建入口。
 
+:::info
+默认情况下，Modern.js 会根据项目目录结构得到对应入口信息。具体可参考[入口](/docs/guides/concept/entries)。
+配置关闭改机制后，需要使用 [`source.entries`](/docs/configure/app/source/entries) 配置自定义入口。
+:::
+
 :::warning 警告
 推荐按照 Modern.js 提供的目录规范组织代码可以更好使用框架的功能，避免一些冗余的配置。
 :::
 
 设置如下，即可关闭默认的行为：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   source: {
     disableDefaultEntries: true,

package/zh/configure/app/source/enable-async-entry.md

@@ -3,8 +3,8 @@ title: source.enableAsyncEntry
 sidebar_label: enableAsyncEntry
 ---
 
-- 类型： `boolean`
-- 默认值： `false`
+* 类型： `boolean`
+* 默认值： `false`
 
 该选项用于 webpack 模块联邦 (Module Federation）场景。
 
@@ -21,7 +21,7 @@ sidebar_label: enableAsyncEntry
 
 首先，在配置文件中开启此选项：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   source: {
     enableAsyncEntry: true,

package/zh/configure/app/source/entries-dir.md

@@ -14,7 +14,7 @@ sidebar_label: entriesDir
 
 例如，当配置与目录结构如下时：
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   source: {
     entriesDir: './src/pages'

package/zh/configure/app/source/entries.md

@@ -3,16 +3,21 @@ title: source.entries
 sidebar_label: entries
 ---
 
-
-
 * 类型： `Object = { [ entryName: string ]: string | Object }`
 * 默认值： 根据当前项目目录结构动态结算出的默认入口对象。
 
-对于大部分场景，Modern.js 根据目录结构自动生成的入口能满足大部分业务需求。
+对于大部分场景，Modern.js 根据目录结构自动生成的入口能满足大部分业务需求。具体可参考[入口](/docs/guides/concept/entries)。
+
+如需自定义构建入口时，可以通过该选项指定。
+
+
+## String 类型
 
-如需自定义构建入口时，可以通过该选项指定。例如，当值为 `string` 时，指向入口的文件路径:
+当值为 `string` 类型时，为入口的文件路径:
+
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
 
-```js title="modern.config.js"
 export default defineConfig({
   source: {
     entries: {
@@ -23,10 +28,11 @@ export default defineConfig({
 });
 ```
 
-自定义的入口，只需要导出 `App` 组件，Modern.js 会生成真正的入口文件。
+自定义的入口，只需要默认导出 `App`, Modern.js 会生成真正的入口文件。
 
 需要关闭这一行为时，可以将值设为 `Object`，属性 `disableMount` 设置为 `true`。
 
+## Object 类型
 
 当值为 `Object` 时，可配置如下属性：
 
@@ -34,7 +40,9 @@ export default defineConfig({
 * `disableMount`：`boolean = false`，关闭 Modern.js 生成入口代码的行为。
 * `enableFileSystemRoutes`：`boolean = false`，是否 [使用约定式路由](/docs/apis/app/hooks/src/pages)。
 
-```js
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
 export default defineConfig({
   source: {
     entries: {
@@ -50,6 +58,5 @@ export default defineConfig({
       },
     },
   },
-};
+});
 ```
-

package/zh/configure/app/source/exclude.md

@@ -0,0 +1,12 @@
+---
+title: source.exclude
+sidebar_label: exclude
+---
+
+:::info BUILDER
+该配置为 Modern.js Builder 配置，可能存在无法跳转的链接。详细信息可参考 [source.exclude](https://modernjs.dev/builder/zh/api/config-source.html#source-exclude)。
+:::
+
+import Main from '@modern-js/builder-doc/zh/config/source/exclude.md'
+
+<Main />

package/zh/configure/app/source/global-vars.md

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

package/zh/configure/app/source/include.md

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

package/zh/configure/app/source/module-scopes.md

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

package/zh/configure/app/source/pre-entry.md

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

package/zh/configure/app/source/resolve-extension-prefix.md

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

package/zh/configure/app/source/resolve-main-fields.md

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

package/zh/configure/app/testing/transformer.md

@@ -4,10 +4,8 @@ sidebar_label: transformer
 sidebar_position: 1
 ---
 
-
-
-- 类型：`'babel-jest' | 'ts-jest'`
-- 默认值：`babel-jest`
+* 类型：`'babel-jest' | 'ts-jest'`
+* 默认值：`babel-jest`
 
 配置执行测试的时候对于源码的编译工具： [babel-jest](https://www.npmjs.com/package/babel-jest) 或 [ts-jest](https://github.com/kulshekhar/ts-jest)。默认使用 `babel-jest`。
 

package/zh/configure/app/tools/autoprefixer.md

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

package/zh/configure/app/tools/babel.md

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

package/zh/configure/app/tools/css-extract.md

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

package/zh/configure/app/tools/css-loader.md

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

package/zh/configure/app/tools/dev-server.md

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

package/zh/configure/app/tools/esbuild.md

@@ -3,8 +3,8 @@ title: tools.esbuild
 sidebar_label: esbuild
 ---
 
-- 类型： `Object`
-- 默认值： `undefined`
+* 类型： `Object`
+* 默认值： `undefined`
 
 ## 介绍
 
@@ -24,8 +24,8 @@ Modern.js 基于 esbuild 提供了代码编译和压缩的能力，在大型工
 
 ### target
 
-- 类型： `string | string[]`
-- 默认值： `'esnext'`
+* 类型： `string | string[]`
+* 默认值： `'esnext'`
 
 为生成的 JavaScript 和 CSS 代码设置目标环境。
 
@@ -44,7 +44,7 @@ Modern.js 基于 esbuild 提供了代码编译和压缩的能力，在大型工
 
 默认情况下，esbuild 压缩过程中会引入 ES6 代码，比如模板字符串。如果需要兼容 ES5，可以将 `target` 设置为 `es5`。
 
-```js title="modern.config.js"
+```typescript title="modern.config.ts"
 export default defineConfig({
   tools: {
     esbuild: {

package/zh/configure/app/tools/html-plugin.md

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

package/zh/configure/app/tools/inspector.md

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