npm - @modern-js/main-doc - Versions diffs - 2.22.1 → 2.23.1 - Mend

@modern-js/main-doc 2.22.1 → 2.23.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

package/docs/zh/guides/basic-features/alias.mdx CHANGED Viewed

@@ -14,7 +14,7 @@ Modern.js 允许在 JS 和 CSS 中使用别名导入自定义目录下的模块
 ```
 :::info
-在开启可选功能时，生成器也会动态的添加内置别名，例如启用 BFF 时默认会添加 `@api` 别名。
+在开启可选功能时，new 命令也会动态的添加内置别名，例如启用 BFF 时默认会添加 `@api` 别名。
 :::
@@ -27,7 +27,7 @@ Modern.js 允许在 JS 和 CSS 中使用别名导入自定义目录下的模块
 │   │   └── base.css
 │   └── utils
 │       └── index.ts
-├── App.tsx
+└── App.tsx
 ```
 `src/App.tsx` 中写法如下：
@@ -37,7 +37,9 @@ import utils from '@/src/common/utils';
 import '@/src/common/styles/base.css';
 ```
-Modern.js 也提供了自定义别名的方式，以添加 `@common` 别名为例，对于 TypeScript 项目，只需要在项目根目录 `tsconfig.json` 下配置 `compilerOptions.paths` 如下：
+Modern.js 也提供了自定义别名的方式，以添加 `@common` 别名为例：
+对于 TypeScript 项目，只需要在项目根目录 `tsconfig.json` 下配置 `compilerOptions.paths`：
 ```json
 {

package/docs/zh/guides/basic-features/html.mdx CHANGED Viewed

@@ -9,7 +9,7 @@ Modern.js 提供了 **JSX 语法**和 **HTML(EJS) 语法**两种方式用于自
 ## JSX 语法
-Modern.js 约定，在 `src/` 目录下，或在入口目录下，可以创建 `Document.[jt]sx` 并默认导出组件。该组件的渲染结果可以作为入口的 HTML 模板。
+Modern.js 约定，在 `src/` 或入口目录下，可以创建 `Document.[jt]sx` 文件并默认导出组件，该组件的渲染结果可以作为入口的 HTML 模板。
 例如以下目录结构：
@@ -27,17 +27,17 @@ Modern.js 约定，在 `src/` 目录下，或在入口目录下，可以创建 `
 `entry-a` 会优先使用当前入口下的 `Docoument.[jt]sx` 文件。如果当前入口没有 `Document.[jt]sx` 文件，例如 `entry-b`，则会查找根目录下的 `Document.[jt]sx` 文件。
-如果还没有，则会兜底到传统模板的逻辑。
+如果未找到，将会使用 Modern.js 的默认模板。
 ### HTML 组件
-Modern.js 提供了一些列渲染页面的组件，用来帮助开发者生成模板，可以从 `@modern-js/runtime/document` 中导出这些组件：
+Modern.js 提供了一些列渲染页面的组件，用来帮助开发者生成模板，可以从 `@modern-js/runtime/document` 中使用这些组件：
 ```tsx
 import { Html, Body, Root, Head, Scripts } from '@modern-js/runtime/document';
 ```
-这些组件分别渲染：
+这些组件分别用于渲染：
 - `Html`：提供原生 HTML Element 的能力，并能默认渲染开发者未添加的必须的组件。`<Head>` 和 `<Body>` 是必须要存在的，其它组件可以按需选择合适的组件进行组装。
@@ -57,10 +57,10 @@ import { Html, Body, Root, Head, Scripts } from '@modern-js/runtime/document';
 Modern.js 也提供了 `DocumentContext` 来提供一些配置、环境参数，方便直接获取。主要以下参数：
-- `processEnv`：提供构建时的 `process.env`
-- `config`：Modern.js 项目的配置。目前只暴露出 output 相关的配置
-- `entryName`：当前的入口名
-- `templateParams`：HTML 模板的参数（为了兼容传统模板，不推荐使用）
+- `processEnv`：提供构建时的 `process.env`。
+- `config`：Modern.js 项目的配置。目前只暴露出 output 相关的配置。
+- `entryName`：当前的入口名。
+- `templateParams`：HTML 模板的参数（为了兼容传统模板，不推荐使用）。
 ### 示例
@@ -151,7 +151,7 @@ export default function Document(): React.ReactElement {
 Modern.js 也支持 HTML 语法。默认情况下，Modern.js 的应用工程中会内置一份 HTML 模板，用于生成 HTML 代码。
-基于 HTML 语法的模板，Modern.js 提供了 **自定义 HTML 片段**和**完全自定义 HTML 模板**两种方式来自定义模板。
+基于 HTML 语法的模板，Modern.js 提供了**自定义 HTML 片段**和**完全自定义 HTML 模板**两种方式来自定义模板。
 ### 自定义 HTML 片段

package/docs/zh/guides/basic-features/mock.mdx CHANGED Viewed

@@ -6,7 +6,7 @@ sidebar_position: 6
 Modern.js 提供了快速生成 Mock 数据的功能，能够让前端独立自主开发，不被后端接口阻塞。
-## Mock 文件
+## 启用 Mock
 约定当 `config/mock` 目录下存在 `index.[jt]s` 时，会自动开启 Mock 功能，如下：
@@ -63,7 +63,7 @@ module.exports = {
 :::
-## 延迟返回
+## 延迟响应
 - 可以使用浏览器「 弱网模拟 」的功能实现。
 - 可以通过 `setTimeout` 为单个接口设置延迟，例如：

package/docs/zh/guides/topic-detail/_category_.json CHANGED Viewed

@@ -1,5 +1,5 @@
 {
   "label": "专题详解",
-  "position": 6,
+  "position": 8,
   "collapsed": false
 }

package/docs/zh/guides/troubleshooting/cli.mdx CHANGED Viewed

@@ -58,6 +58,6 @@ pnpm v6:
 总结来说：
-**在使用 pnpm v7 时，如果传递参数给 pnpm，需要将参数放置到命令前**
+**在使用 pnpm v7 时，如果传递参数给 pnpm，需要将参数放置到命令前**。
 **在使用 pnpm v6 时，如果传递的参数给 pnpm，不需要加 `--`；如果传递的参数是给脚本使用，需要增加 `--` 字符串**。

package/docs/zh/guides/troubleshooting/dependencies.mdx CHANGED Viewed

@@ -105,6 +105,6 @@ Type '{}' is not assignable to type 'ReactNode'.
 **Modern.js 框架推荐使用的 React 版本为 >= 18.0.0**，并且不同功能对 React 版本的要求有所不同。
 - 如果你在使用 React 17，那么部分框架功能将无法使用，比如 Steaming SSR，因为它依赖 React 18 提供的新特性。
-- 如果你仍然在使用 React 16，那么将无法使用 Modern.js 的运行时或服务端能力。你可以考虑使用 Modern.js 的构建模式，即只使用 Modern.js 的构建能力，这种情况是可以继续使用 React 16 的。
+- 如果你仍然在使用 React 16，那么将无法使用 Modern.js 的运行时或服务端能力。你可以考虑使用 Modern.js 的构建模式，即只使用 Modern.js 的构建能力，这种情况可以继续使用 React 16。
 在 Modern.js 未来的 major 版本中，我们会逐步移除对 React 16 和 React 17 的支持。因此，请尽快升级到 React 18 以上版本。

package/package.json CHANGED Viewed

@@ -15,13 +15,14 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.22.1",
+  "version": "2.23.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "^2.22.1"
+    "@modern-js/builder-doc": "^2.23.1"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -33,9 +34,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "2.22.1",
-    "@modern-js/doc-tools": "2.22.1",
-    "@modern-js/doc-plugin-auto-sidebar": "2.22.1"
+    "@modern-js/builder-doc": "2.23.1",
+    "@modern-js/doc-tools": "2.23.1",
+    "@modern-js/doc-plugin-auto-sidebar": "2.23.1"
   },
   "scripts": {
     "dev": "modern dev",