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

package/zh/{configure/generator/introduce.md → guides/topic-detail/generator/config/common.md}

@@ -2,21 +2,11 @@
 sidebar_position: 1
 ---
 
-# 介绍
+# 通用配置
 
-Modern.js 提供了应用(MWA)、模块、Monorepo 三种工程方案类型，并支持通过 `@modern-js/create` 创建工程方案初始化项目。
+### solution
 
-使用 `@modern-js/create` 时会询问用户一些问题来生成符合用户需求的项目，这一章将介绍这里的问题字段便于进行定制化工程方案开发时使用。
-
-:::info
-配置章节将使用同时介绍内容和字段值的方式，括号中内容为对应的字段值
-:::
-
-## 工程方案配置
-
-### Solution
-
-工程方案类型(solution)，共三个选项：
+工程方案类型(solution)，选项如下：
 
 - 应用(mwa)
 
@@ -28,7 +18,7 @@ Modern.js 提供了应用(MWA)、模块、Monorepo 三种工程方案类型，
 solution 配置只能在 `@modern-js/create` 的 `--config` 参数中使用，不能在生成器插件中通过设置输入默认值的方式使用。
 :::
 
-### Scenes
+### scenes
 
 项目场景(scenes)，当使用创建工程方案场景类型的生成器插件时，该值为对应生成器插件的 key 值。
 
@@ -36,19 +26,17 @@ solution 配置只能在 `@modern-js/create` 的 `--config` 参数中使用，
 scenes 配置只能在 `@modern-js/create` 的 `--config` 参数中使用，不能在生成器插件中通过设置输入默认值的方式使用。
 :::
 
-## 通用配置
+### language
 
-### Language
-
-开发语言(language)，共有两个选项：
+开发语言(language)，选项如下：
 
 - TS(ts)
 
 - ES6+(js)
 
-### Package-Manager
+### packageManager
 
-包管理工具(packageManager)，共有两个选项：
+包管理工具(packageManager)，选项如下：
 
 - pnpm(pnpm)
 
@@ -63,51 +51,56 @@ scenes 配置只能在 `@modern-js/create` 的 `--config` 参数中使用，不
 
 ### noNeedInstall
 
-是否跳过依赖安装。
+* Type: Boolean
 
-type: Boolean
+* Default: false
 
-default: false
+是否跳过依赖安装。
 
 ### noNeedGit
 
-是否跳过 git 初始化和提交初始 commit。
+* Type: Boolean
 
-type: Boolean
+* Default: false
 
-default: false
+是否跳过 git 初始化和提交初始 commit。
 
 ### successInfo
 
-自定义创建项目成功的提示信息。
+* Type: String
 
-type: String
+* Default: 不同工程方案的命令操作提示
 
-default: 不同工程方案的命令操作提示
+自定义创建项目成功的提示信息。
 
 ### isMonorepoSubProject
 
-是否为 Monorepo 子项目。
+* Type: Boolean
+
+* Default: false
 
-type: Boolean
+是否为 Monorepo 子项目。
 
-default: false
 ### isTest
 
-作用于 `应用(MWA)` 项目，标识是否为测试项目。
+* Type: Boolean
+
+   - true: 创建到路径 `examples/`
 
-type: Boolean
-- true: 创建到路径 `examples/`
-- false: 创建到路径 `apps/`
+   - false: 创建到路径 `apps/`
 
-default: false
+* Default: false
+
+作用于 `应用(MWA)` 项目，标识是否为测试项目。
 
 ### isPublic
 
-作用于 `模块(Module)` 项目，标识是否需要对外发布。
+* Type: Boolean
 
-type: Boolean
-- true: 创建到路径 `packages/`
-- false: 创建到路径 `features/`
+   - true: 创建到路径 `packages/`
 
-default: false
+   - false: 创建到路径 `features/`
+
+* Default: false
+
+作用于 `模块(Module)` 项目，标识是否需要对外发布。

package/zh/{configure/generator → guides/topic-detail/generator/config}/module.md

@@ -4,13 +4,13 @@ sidebar_position: 3
 
 # 模块
 
-模块项目默认包含通用配置，通用配置可查看[通用配置](/docs/configure/generator/introduce#通用配置)。
-
-## 创建项目
+## 项目创建
 
 创建项目时配置，`@modern-js/create` 使用 `--config` 参数时使用的配置，也是在生成器插件中修改和添加 input 时使用的配置。
 
-### Package-Name
+模块项目默认包含通用配置，通用配置可查看[通用配置](/docs/guides/topic-detail/generator/config/common)。
+
+### packageName
 
 包名(packageName)，字符串类型，为输入值。
 
@@ -18,7 +18,7 @@ sidebar_position: 3
 
 模块项目中 new 命令配置， 可以在执行 new 命令时通过 `--config` 参数配置，也可在生成器插件中创建元素和启用功能时使用。
 
-### Action-Type
+### actionType
 
 New 命令的操作类型(actionType)，类型支持一种：
 
@@ -28,16 +28,12 @@ New 命令的操作类型(actionType)，类型支持一种：
 在生成器插件中使用启用功能和创建元素时不需要该参数，生成器插件中自动添加该参数。
 :::
 
-### Function
+### function
 
-可选功能名称(function)，支持 11 个选项:
+可选功能名称(function)，支持如下选项:
 
 - Tailwind CSS(tailwindcss)
 
-- Less(less)
-
-- Sass(sass)
-
 - Storybook(mwa_storybook)
 
 - Runtime API(runtimeApi)

package/zh/{configure/generator → guides/topic-detail/generator/config}/monorepo.md

@@ -4,13 +4,13 @@ sidebar_position: 4
 
 # Monorepo
 
-Monorepo 项目默认只需要 [PackageManager 配置](/docs/configure/generator/introduce#package-manager)。
+Monorepo 项目默认只需要 [PackageManager 配置](/docs/guides/topic-detail/generator/config/common#packagemanager)。
 
 ## 创建子项目
 
 Monorepo 项目支持通过使用 new 命令创建子项目，子项目类型支持应用、测试应用、模块、内部模块，除了应用和模块各自的配置外，这里还需要一些通用的子项目配置。
 
-### Solution
+### solution
 
 子项目类型(solution)，不同子项目类型字段为:
 
@@ -19,10 +19,10 @@ Monorepo 项目支持通过使用 new 命令创建子项目，子项目类型支
 - 模块(module)
 - 模块（内部）(inner_module)
 
-### Package-Name
+### packageName
 
 子项目名称(packageName)，字符串类型。
 
-### Package-Path
+### packagePath
 
 子项目路径(packagePath)，字符串类型。

package/zh/{configure/generator → guides/topic-detail/generator/config}/mwa.md

@@ -4,39 +4,17 @@ sidebar_position: 2
 
 # 应用
 
-应用项目默认包含通用配置，通用配置可查看[通用配置](/docs/configure/generator/introduce#通用配置)。
-
-## 创建项目
+## 项目创建
 
 创建项目时配置，`@modern-js/create` 使用 `--config` 参数时使用的配置，也是在生成器插件中修改和添加 input 时使用的配置。
 
-### Need-Modify-MWA-Config
-
-是否需要修改应用默认配置(needModifyMWAConfig)。
-
-该配置值为 `yes` 时，后续配置才会展示给用户。
-
-在使用 `--config` 参数或者在生成器插件中时，配置值为 `yes` 后续配置才会生效。
-
-该字段共有两个选项：
-
-- 是(yes)
-
-- 否(no)
-
-### Client-Route
-
-客户端路由配置(clientRoute)，默认为自控路由，共有两个选项：
-
-- 自控路由(selfControlRoute)
-
-- 约定式路由(conventionalRoute)
+应用项目创建参数都为[通用配置](/docs/guides/topic-detail/generator/config/common)。
 
 ## New 命令
 
 应用项目中 new 命令配置， 可以在执行 new 命令时通过 `--config` 参数配置，也可在生成器插件中创建元素和启用功能时使用。
 
-### Action-Type
+### actionType
 
 New 命令的操作类型(actionType)，类型支持两种：
 
@@ -48,7 +26,7 @@ New 命令的操作类型(actionType)，类型支持两种：
 在生成器插件中使用启用功能和创建元素时不需要该参数，生成器插件中自动添加该参数。
 :::
 
-### Element
+### element
 
 元素名称(element)，支持两个选项：
 
@@ -58,34 +36,26 @@ New 命令的操作类型(actionType)，类型支持两种：
 
 这两个选项还需要配置具体的配合使用，介绍如下：
 
-#### Name
+#### name
 
 入口名称(name), 字符串类型。
 
 创建入口除了`name`之外，还需要 `needModifyMWAConfig`、`clientRoute` 字段。
 
-#### Framework
+#### framework
 
-自定义 Server 运行时框架(framework)，支持四个选项：
-
-- Egg(egg)
+自定义 Server 运行时框架(framework)，支持两个选项：
 
 - Express(express)
 
 - Koa(koa)
 
-- Nest(nest)
-
-### Function
+### function
 
 可选功能名称(function)，支持如下选项:
 
 - Tailwind CSS(tailwindcss)
 
-- Less(less)
-
-- Sass(sass)
-
 - BFF(bff)
 
 - SSG(ssg)
@@ -106,7 +76,7 @@ New 命令的操作类型(actionType)，类型支持两种：
 
 #### BFF 相关参数
 
-##### BFF-Type
+##### bffType
 
 BFF 类型(bffType)，支持两个选项：
 
@@ -114,14 +84,10 @@ BFF 类型(bffType)，支持两个选项：
 
 - 框架模式(framework)
 
-##### Framework
+##### framework
 
-自定义 Server 运行时框架(framework)，支持四个选项：
-
-- Egg(egg)
+扩展 Web Server 运行时框架(framework)，支持两个选项：
 
 - Express(express)
 
 - Koa(koa)
-
-- Nest(nest)

package/zh/guides/topic-detail/generator/plugin/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "开发生成器插件",
+  "position": 4
+}

package/zh/guides/topic-detail/generator/plugin/api/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "API",
+  "position": 4
+}

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/file/addFile.md

@@ -29,7 +29,7 @@ export type ForgedAPI = {
 
 ## type
 
-文件类型，具体可查看[文件类型](/docs/apis/generator/plugin/file/introduce#%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B)。
+文件类型，具体可查看[文件类型](/docs/guides/topic-detail/generator/plugin/api/file/introduce#文件类型)。
 
 ## file
 

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/file/addManyFile.md

@@ -29,7 +29,7 @@ export type ForgedAPI = {
 
 ## type
 
-文件类型，具体可查看[文件类型](/docs/apis/generator/plugin/file/introduce#%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B)。
+文件类型，具体可查看[文件类型](/docs/guides/topic-detail/generator/plugin/api/file/introduce#文件类型)。
 
 ## destination
 

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/hook/afterForged.md

@@ -28,7 +28,7 @@ afterForged 参数是一个回调函数，函数参数为 api 和 inputData。
 
 ### api
 
-在 afterForged 生命周期中支持的函数列表，具体可查看[Git API](/docs/apis/generator/plugin/git/isInGitRepo) 和[NPM API](/docs/apis/generator/plugin/npm/install)。
+在 afterForged 生命周期中支持的函数列表，具体可查看 [Git API](/docs/guides/topic-detail/generator/plugin/api/git/isInGitRepo) 和 [NPM API](/docs/guides/topic-detail/generator/plugin/api/npm/install)。
 
 ### inputData
 

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/hook/onForged.md

@@ -28,7 +28,7 @@ onForged 参数是一个回调函数，函数参数为 api 和 inputData。
 
 ### api
 
-在 onForged 生命周期中支持的函数列表，具体可查看[文件操作 API](/docs/apis/generator/plugin/file/introduce) 和[启用功能 API](/docs/apis/generator/plugin/new/introduce)。
+在 onForged 生命周期中支持的函数列表，具体可查看[文件操作 API](/docs/guides/topic-detail/generator/plugin/api/file/introduce) 和[启用功能 API](/docs/guides/topic-detail/generator/plugin/api/new/introduce)。
 
 ### inputData
 

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/input/addInputAfter.md

@@ -12,18 +12,18 @@ sidebar_position: 3
 
 ```ts
 export interface IPluginContext {
-  addInputAfter: (key: string, input: IInput) => void;
+  addInputAfter: (key: string, input: Schema) => void;
   ...
 }
 ```
 
 ## key
 
-Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成器配置](/docs/configure/generator/introduce)。
+Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成器配置](/docs/guides/topic-detail/generator/config/common)。
 
 ## input
 
-需要添加的问题，具体类型定义可查看[自定义输入相关类型定义](/docs/apis/generator/plugin/input/type)。
+需要添加的问题，具体类型定义可查看[自定义输入相关类型定义](/docs/guides/topic-detail/generator/plugin/api/input/type)。
 
 ## 示例
 
@@ -31,9 +31,17 @@ Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成
 
 ```ts
 context.addInputAfter('packageManager', {
-    key: 'test',
-    name: '测试输入',
-    type: 'input'
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: i18n.t(localeKeys.plugin_type.self),
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
 })
 ```
 

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/input/addInputBefore.md

@@ -12,18 +12,18 @@ sidebar_position: 2
 
 ```ts
 export interface IPluginContext {
-  addInputBefore: (key: string, input: IInput) => void;
+  addInputBefore: (key: string, input: Schema) => void;
   ...
 }
 ```
 
 ## key
 
-Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成器配置](/docs/configure/generator/introduce)。
+Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成器配置](/docs/guides/topic-detail/generator/config/common)。
 
 ## input
 
-需要添加的问题，具体类型定义可查看[自定义输入相关类型定义](/docs/apis/generator/plugin/input/type)。
+需要添加的问题，具体类型定义可查看[自定义输入相关类型定义](/docs/guides/topic-detail/generator/plugin/api/input/type)。
 
 ## 示例
 
@@ -31,9 +31,17 @@ Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成
 
 ```ts
 context.addInputBefore('packageManager', {
-    key: 'test',
-    name: '测试输入',
-    type: 'input'
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: i18n.t(localeKeys.plugin_type.self),
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
 })
 ```
 

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/input/setInput.md

@@ -23,7 +23,7 @@ export interface IPluginContext {
 
 ## filed
 
-需设置的问题字段，可修改除了当前 Input 除 key 以外的其他字段，Input 具体类型定义可查看[自定义输入相关类型定义](/docs/apis/generator/plugin/input/type)。
+需设置的问题字段，可修改除了当前 Input 除 key 以外的其他字段，Input 具体类型定义可查看[自定义输入相关类型定义](/docs/guides/topic-detail/generator/plugin/api/input/type)。
 
 ## value
 
@@ -38,5 +38,5 @@ export interface IPluginContext {
 修改 packageName 的展示名称
 
 ```ts
-context.setInput('packageName', 'name', "展示名称");
+context.setInput('packageName', 'title', "展示名称");
 ```

package/zh/guides/topic-detail/generator/plugin/api/input/type.md

@@ -0,0 +1,65 @@
+---
+sidebar_position: 1
+---
+
+# 自定义输入相关类型定义
+
+## Input
+
+Modern.js Input 输入类型采用了开源的 [Formily](https://formilyjs.org/) Schema 结果，支持了部分其 Schema 字段。
+
+### type
+
+schema 类型，目前生成器插件输入支持的类型为 `string`、`number` 和 `object` 类型。其中 `object` 用于实现 schema 嵌套，需要和 `properties` 配合使用。
+
+### name
+
+schema 的关键字。
+
+### title
+
+schema 的展示名称。
+
+### default
+
+schema 默认值。
+
+### enum
+
+schema 如果为选择类型，该字段用于定义选项内容。
+
+每个选项支持两个字段：
+
+- value: 选项值。
+
+- label: 展示名称。
+
+### x-validate
+
+schema 的验证规则。这里支持 Formily 的校验方式，具体可参考 [Formily 表单校验](https://formilyjs.org/zh-CN/guide/advanced/validate)。
+
+### x-reactions
+
+schema 字段联动。这里支持 Formily 的联动方式，具体可参考 [Formily 实现联动逻辑](https://formilyjs.org/zh-CN/guide/advanced/linkages)。
+
+### properties
+
+当 schema 类型为 `object` 时，定义其子表单。
+
+## 示例
+
+```typescript
+const schema = {
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: i18n.t(localeKeys.plugin_type.self),
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
+};
+```

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/new/createElement.md

@@ -30,4 +30,4 @@ export type ForgedAPI = {
 
 ## params
 
-创建元素的其他参数，详细参考[应用 New 命令](/docs/configure/generator/mwa#new-%E5%91%BD%E4%BB%A4)。
+创建元素的其他参数，详细参考[应用 New 命令](/docs/guides/topic-detail/generator/config/mwa#new-命令)。

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/new/createSubProject.md

@@ -32,4 +32,4 @@ export type ForgedAPI = {
 
 ## params
 
-创建子项目的其他参数，详细参考[Monorepo 创建子项目](/docs/configure/generator/monorepo#%E5%88%9B%E5%BB%BA%E5%AD%90%E9%A1%B9%E7%9B%AE)。
+创建子项目的其他参数，详细参考[Monorepo 创建子项目](/docs/guides/topic-detail/generator/config/monorepo#创建子项目)。

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/new/enableFunc.md

@@ -14,8 +14,6 @@ sidebar_position: 3
 export enum ActionFunction {
   UnBundle = 'unbundle',
   TailwindCSS = 'tailwindcss',
-  Less = 'less',
-  Sass = 'sass',
   BFF = 'bff',
   MicroFrontend = 'micro_frontend',
   I18n = 'i18n',
@@ -43,4 +41,4 @@ export type ForgedAPI = {
 
 ## params
 
-启用功能时其他参数，详细参考[应用 New 命令](/docs/configure/generator/mwa#new-%E5%91%BD%E4%BB%A4)和[模块 New 命令](/docs/configure/generator/module#new-命令)。
+启用功能时其他参数，详细参考[应用 New 命令](/docs/guides/topic-detail/generator/config/mwa#new-命令)和[模块 New 命令](/docs/guides/topic-detail/generator/config/module#new-命令)。

package/zh/{apis/generator/plugin → guides/topic-detail/generator/plugin/api}/new/introduce.md

@@ -8,8 +8,8 @@ Modern.js 提供的三个工程方案支持在项目中执行 new 命令创建
 
 不同的工程方案支持的 new 操作
 
-- [应用](/docs/configure/generator/mwa#new-%E5%91%BD%E4%BB%A4)
+- [应用](/docs/guides/topic-detail/generator/config/mwa#new-命令)
 
-- [模块](/docs/configure/generator/module#new-命令)
+- [模块](/docs/guides/topic-detail/generator/config/module#new-命令)
 
-- [Monorepo](/docs/configure/generator/monorepo#创建子项目)
+- [Monorepo](/docs/guides/topic-detail/generator/config/monorepo#创建子项目)