@modern-js/main-doc 0.0.0-next-1681740447801 → 0.0.0-next-1681819855170

package/CHANGELOG.md

@@ -1,14 +1,20 @@
 # @modern-js/main-doc
 
-## 0.0.0-next-1681740447801
+## 0.0.0-next-1681819855170
 
 ### Patch Changes
 
 - 60a81d05d: feat: add ssr.inlineScript for use inline json instead inline script when ssr
   feat: 添加 ssr.inlineScript 用于在 ssr 模式下使用内联 json 而不是内联脚本
+- 432ac8b88: chore(cli): improve commands descriptions
+
+  chore(cli): 优化命令的描述文案
+
+- de84d9494: feat: add optional dynamic routes docs
+  feat: 添加可选动态路由文档
 - Updated dependencies [fefd1c564]
 - Updated dependencies [1f34dbae9]
-  - @modern-js/builder-doc@0.0.0-next-1681740447801
+  - @modern-js/builder-doc@0.0.0-next-1681819855170
 
 ## 2.13.4
 

package/docs/en/apis/app/hooks/src/routes.mdx

@@ -56,6 +56,26 @@ In the component, you can get the corresponding parameters by [useParams](/apis/
 
 In the loader, params will be used as input to [loader](/guides/basic-features/data-fetch#loader-function), and the corresponding parameters can be retrieved through the property `params`.
 
+## Dynamic Optional Routes
+
+By using file directories named with `[$]`, the generated routes will be treated as dynamic routes. For example, the following file directory:
+
+```
+└── routes
+    ├── user
+    │   └── [id$]
+    │       └── page.tsx
+    ├── blog
+    │   └── page.tsx
+    └── page.tsx
+```
+
+The `routes/user/[id$]/page.tsx` file will be converted to the `/user/:id?` route. All routes under `/user` will match this route, and the `id` parameter is optional. This route is commonly used to differentiate between **creating** and **editing**.
+
+In the component, you can get the corresponding named parameters using [useParams](/apis/app/runtime/router/router#useparams).
+
+In the loader, params will be passed as an argument to the [loader](/guides/basic-features/data-fetch#loader-函数), and you can get them through `params.xxx`.
+
 ## Layout component
 
 As in the example below, you can add a common layout component for all routing components by adding `layout.tsx`

package/docs/en/components/init-app.mdx

@@ -13,11 +13,11 @@ After create the project, Modern.js automatically installs dependency and create
 [INFO] git repository has been automatically created
 [INFO] Success！
 You can run the following command in the directory of the new project:
-pnpm run dev          # Run and debug the project according to the requirements of the development environment
-pnpm run build        # Build the project according to the requirements of the product environment
-pnpm run serve        # Run the project according to the requirements of the product environment
-pnpm run lint         # Check and fix all codes
-pnpm run new          # Create more project elements, such as application portals
+pnpm run dev          # Starting the dev server
+pnpm run build        # Build the app for production
+pnpm run serve        # Preview the production build locally
+pnpm run lint         # Run ESLint and automatically fix problems
+pnpm run new          # Enable optional features or add a new entry
 ```
 
 :::note

package/docs/zh/components/init-app.mdx

@@ -13,11 +13,11 @@ Modern.js 生成器会提供一个可交互的问答界面，根据结果初始
 [INFO] git 仓库初始化成功
 [INFO] 创建成功！
 可在新项目的目录下运行以下命令：
-pnpm run dev          # 按开发环境的要求，运行和调试项目
-pnpm run build        # 按生产环境的要求，构建项目
-pnpm run serve        # 按生产环境的要求，运行项目
-pnpm run lint         # 检查和修复所有代码
-pnpm run new          # 继续创建更多项目要素，比如应用入口
+pnpm run dev          # 启动开发服务器
+pnpm run build        # 构建生产环境产物
+pnpm run serve        # 启动生产环境服务
+pnpm run lint         # 运行 ESLint 并自动修复问题
+pnpm run new          # 启用可选功能或创建项目要素
 ```
 
 :::note

package/docs/zh/guides/basic-features/routes.mdx

@@ -169,6 +169,26 @@ export default () => {
 
 在 loader 中，params 会作为 [loader](/guides/basic-features/data-fetch#loader-函数) 的入参，通过 `params.xxx` 可以获取。
 
+### 动态可选路由
+
+通过 `[$]` 命名的文件目录，生成的路由会作为动态路由。例如以下文件目录：
+
+```
+└── routes
+    ├── user
+    │   └── [id$]
+    │       └── page.tsx
+    ├── blog
+    │   └── page.tsx
+    └── page.tsx
+```
+
+`routes/user/[id$]/page.tsx` 文件会转为 `/user/:id?` 路由。`/user` 下的所有路由都会匹配到该路由，并且 `id` 参数可选存在。通常在区分**创建**于**编辑**时，可以使用该路由。
+
+在组件中，可以通过 [useParams](/apis/app/runtime/router/router#useparams) 获取对应命名的参数。
+
+在 loader 中，params 会作为 [loader](/guides/basic-features/data-fetch#loader-函数) 的入参，通过 `params.xxx` 可以获取。
+
 ### 通配路由
 
 如果在 routes 目录下创建 `$.tsx` 文件，该文件会作为通配路由组件，当没有匹配的路由时，会渲染该路由组件。

package/docs/zh/guides/topic-detail/monorepo/create-sub-project.mdx

@@ -59,9 +59,9 @@ pnpm run new
 [INFO] 依赖自动安装成功
 [INFO] 创建成功！
 可在新项目的目录下运行以下命令：
-pnpm run dev          # 按开发环境的要求，运行和调试项目
-pnpm run build        # 按生产环境的要求，构建项目
-pnpm run serve        # 按生产环境的要求，运行项目
-pnpm run lint         # 检查和修复所有代码
-pnpm run new          # 继续创建更多项目要素，比如应用入口
+pnpm run dev          # 启动开发服务器
+pnpm run build        # 构建生产环境产物
+pnpm run serve        # 启动生产环境服务
+pnpm run lint         # 运行 ESLint 并自动修复问题
+pnpm run new          # 启用可选功能或创建项目要素
 ```

package/package.json

@@ -11,13 +11,13 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-1681740447801",
+  "version": "0.0.0-next-1681819855170",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-1681740447801"
+    "@modern-js/builder-doc": "0.0.0-next-1681819855170"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -29,9 +29,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-1681740447801",
-    "@modern-js/doc-tools": "0.0.0-next-1681740447801",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1681740447801"
+    "@modern-js/builder-doc": "0.0.0-next-1681819855170",
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1681819855170",
+    "@modern-js/doc-tools": "0.0.0-next-1681819855170"
   },
   "scripts": {
     "dev": "modern dev",