@modern-js/main-doc 2.28.0 → 2.30.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @modern-js/main-doc
 
+## 2.30.0
+
+### Patch Changes
+
+- cc5f49e: feat(builder): add performance.transformLodash config
+
+  feat(builder): 新增 performance.transformLodash 配置
+
+- Updated dependencies [cc5f49e]
+  - @modern-js/builder-doc@2.30.0
+
+## 2.29.0
+
+### Patch Changes
+
+- @modern-js/builder-doc@2.29.0
+
 ## 2.28.0
 
 ### Patch Changes

package/docs/en/community/contributing-guide.mdx

@@ -17,26 +17,25 @@ own GitHub account and then [clone](https://help.github.com/articles/cloning-a-r
 
 ### Install Node.js
 
-We recommend using Node.js 16 or 18. You can check your currently used Node.js version with the following command:
+We recommend using Node.js 18. You can check your currently used Node.js version with the following command:
 
 ```bash
 node -v
-#v16.18.0
 ```
 
 If you do not have Node.js installed in your current environment, you can use [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) to install it.
 
-Here is an example of how to install the Node.js 16 LTS version via nvm:
+Here is an example of how to install the Node.js 18 LTS version via nvm:
 
 ```bash
-# Install the LTS version of Node.js 16
-nvm install 16 --lts
+# Install the LTS version of Node.js 18
+nvm install 18 --lts
 
-# Make the newly installed Node.js 16 as the default version
-nvm alias default 16
+# Make the newly installed Node.js 18 as the default version
+nvm alias default 18
 
-# Switch to the newly installed Node.js 16
-nvm use 16
+# Switch to the newly installed Node.js 18
+nvm use 18
 ```
 
 ### Install pnpm

package/docs/en/configure/app/performance/dns-prefetch.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: dnsPrefetch
+---
+
+# performance.dnsPrefetch
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [performance.dnsPrefetch](https://modernjs.dev/builder/en/api/config-performance.html#performancednsprefetch).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/performance/dnsPrefetch.md';
+
+<Main />

package/docs/en/configure/app/performance/preconnect.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: preconnect
+---
+
+# performance.preconnect
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [performance.preconnect](https://modernjs.dev/builder/en/api/config-performance.html#performancepreconnect).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/performance/preconnect.md';
+
+<Main />

package/docs/en/configure/app/performance/prefetch.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: prefetch
+---
+
+# performance.prefetch
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [performance.prefetch](https://modernjs.dev/builder/en/api/config-performance.html#performanceprefetch).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/performance/prefetch.md';
+
+<Main />

package/docs/en/configure/app/performance/preload.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: preload
+---
+
+# performance.preload
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [performance.preload](https://modernjs.dev/builder/en/api/config-performance.html#performancepreload).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/performance/preload.md';
+
+<Main />

package/docs/en/configure/app/performance/transform-lodash.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: transformLodash
+---
+
+# performance.transformLodash
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [performance.transformLodash](https://modernjs.dev/builder/en/api/config-performance.html#performancetransformlodash).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/performance/transformLodash.md';
+
+<Main />

package/docs/en/guides/troubleshooting/dependencies.mdx

@@ -46,7 +46,7 @@ The engine "node" is incompatible with this module.
 Expected version ">=14.17.6". Got "12.20.1"
 ```
 
-When using Modern.js, it is recommended to use the latest version of [Node.js 14.x](https://nodejs.org/download/release/latest-v14.x/) or [Node.js 16.x](https://nodejs.org/download/release/latest-v16.x/).
+When using Modern.js, it is recommended to use the latest version of [Node.js 18.x](https://nodejs.org/download/release/latest-v18.x/).
 
 If the Node.js version of the current environment is lower than the above requirement, you can use tools such as [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) to switch versions.
 
@@ -104,7 +104,20 @@ In most cases, peer dependencies warnings will not affect the project operation
 
 **The recommended React version for the Modern.js framework is >= 18.0.0**, and different functions have different requirements for the React version.
 
-- If you are using React 17, some framework functions will not be available, such as Steaming SSR, because it relies on new features provided by React 18.
+- If you are using React 17, some framework functions will not be available, such as Streaming SSR, because it relies on new features provided by React 18.
 - If you are still using React 16, you will not be able to use Modern.js's runtime or server-side capabilities. You can consider using the build mode of Modern.js, that is, only using Modern.js's build capabilities. In this case, React 16 can still be used.
 
 In future major versions of Modern.js, we will gradually remove support for React 16 and React 17. Therefore, please upgrade to React 18 or higher as soon as possible.
+
+---
+
+### Type error in Modern.js configuration file?
+
+```bash
+Type 'CliPlugin<{}, {}, {}, {}>' is not assignable to type 'CliPlugin<any, {}, {}, {}>'.
+  Types of property 'setup' are incompatible.
+```
+
+When you use the Modern.js framework, the above error occurs in the configuration file, it may be due to the inconsistent versions of Modern.js related packages。You can upgrade and unify the version of modern.js related packages through `npx modern upgrade` command.
+
+In the monorepo, the above error may also occur due to inconsistent versions of the Modern.js framework used by different sub-projects.

package/docs/zh/community/contributing-guide.mdx

@@ -16,26 +16,25 @@ sidebar_position: 3
 
 ### 安装 Node.js
 
-我们推荐使用 Node.js 16 或 18。你可以通过以下命令查看当前使用的 Node.js 版本：
+我们推荐使用 Node.js 18。你可以通过以下命令查看当前使用的 Node.js 版本：
 
 ```bash
 node -v
-#v16.18.0
 ```
 
 如果你当前环境没有安装 Node.js，可以使用 [nvm](https://github.com/nvm-sh/nvm)或者 [fnm](https://github.com/Schniz/fnm) 来安装它。
 
-以下是如何通过 nvm 安装 Node.js 16 LTS 版本的示例：
+以下是如何通过 nvm 安装 Node.js 18 LTS 版本的示例：
 
 ```bash
-# 安装 Node.js 16 的 LTS 版本
-nvm install 16 --lts
+# 安装 Node.js 18 的 LTS 版本
+nvm install 18 --lts
 
-# 将新安装的 Node.js 16 设为默认版本
-nvm alias default 16
+# 将新安装的 Node.js 18 设为默认版本
+nvm alias default 18
 
-# 切换到新安装的 Node.js 16
-nvm use 16
+# 切换到新安装的 Node.js 18
+nvm use 18
 ```
 
 ### 安装 pnpm

package/docs/zh/configure/app/performance/dns-prefetch.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: dnsPrefetch
+---
+
+# performance.dnsPrefetch
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [performance.dnsPrefetch](https://modernjs.dev/builder/api/config-performance.html#performancednsprefetch)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/performance/dnsPrefetch.md';
+
+<Main />

package/docs/zh/configure/app/performance/preconnect.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: preconnect
+---
+
+# performance.preconnect
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [performance.preconnect](https://modernjs.dev/builder/api/config-performance.html#performancepreconnect)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/performance/preconnect.md';
+
+<Main />

package/docs/zh/configure/app/performance/prefetch.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: prefetch
+---
+
+# performance.prefetch
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [performance.prefetch](https://modernjs.dev/builder/api/config-performance.html#performanceprefetch)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/performance/prefetch.md';
+
+<Main />

package/docs/zh/configure/app/performance/preload.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: preload
+---
+
+# performance.preload
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [performance.preload](https://modernjs.dev/builder/api/config-performance.html#performancepreload)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/performance/preload.md';
+
+<Main />

package/docs/zh/configure/app/performance/transform-lodash.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: transformLodash
+---
+
+# performance.transformLodash
+
+:::tip
+该配置由 Modern.js Builder 提供，更多信息可参考 [performance.transformLodash](https://modernjs.dev/builder/api/config-performance.html#performancetransformlodash)。
+:::
+
+import Main from '@modern-js/builder-doc/docs/zh/config/performance/transformLodash.md';
+
+<Main />

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

@@ -46,7 +46,7 @@ The engine "node" is incompatible with this module.
 Expected version ">=14.17.6". Got "12.20.1"
 ```
 
-使用 Modern.js 时，建议使用 [Node.js 14.x](https://nodejs.org/download/release/latest-v14.x/) 或 [Node.js 16.x](https://nodejs.org/download/release/latest-v16.x/) 的最新版本。
+使用 Modern.js 时，建议使用 [Node.js 18.x](https://nodejs.org/download/release/latest-v18.x/) 的最新版本。
 
 如果当前环境的 Node.js 版本低于上述要求的版本，则可以使用 [nvm](https://github.com/nvm-sh/nvm) 或 [fnm](https://github.com/Schniz/fnm) 等工具进行版本切换。
 
@@ -104,7 +104,20 @@ Type '{}' is not assignable to type 'ReactNode'.
 
 **Modern.js 框架推荐使用的 React 版本为 >= 18.0.0**，并且不同功能对 React 版本的要求有所不同。
 
-- 如果你在使用 React 17，那么部分框架功能将无法使用，比如 Steaming SSR，因为它依赖 React 18 提供的新特性。
+- 如果你在使用 React 17，那么部分框架功能将无法使用，比如 Streaming SSR，因为它依赖 React 18 提供的新特性。
 - 如果你仍然在使用 React 16，那么将无法使用 Modern.js 的运行时或服务端能力。你可以考虑使用 Modern.js 的构建模式，即只使用 Modern.js 的构建能力，这种情况可以继续使用 React 16。
 
 在 Modern.js 未来的 major 版本中，我们会逐步移除对 React 16 和 React 17 的支持。因此，请尽快升级到 React 18 以上版本。
+
+---
+
+### Modern.js 配置出现类型错误？
+
+```bash
+Type 'CliPlugin<{}, {}, {}, {}>' is not assignable to type 'CliPlugin<any, {}, {}, {}>'.
+  Types of property 'setup' are incompatible.
+```
+
+当你在使用 Modern.js 框架时配置文件出现以上报错，可能是由于 Modern.js 相关包的版本号未统一导致。可以通过 `npx modern upgrade` 命令对 modern.js 依赖进行升级和版本统一。
+
+在 monorepo 中由于不同子项目所用的 Modern.js 框架版本不一致也可能出现以上问题。

package/package.json

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

package/src/components/Footer/index.tsx

@@ -1,4 +1,3 @@
-import React from 'react';
 import { useI18n, useUrl } from '../../i18n';
 import styles from './styles.module.scss';
 
@@ -35,11 +34,11 @@ export default function Footer() {
         },
         {
           label: t('basicFeatures'),
-          to: useUrl('/guides/basic-features/'),
+          to: useUrl('/guides/basic-features/routes'),
         },
         {
           label: t('advancedFeatures'),
-          to: useUrl('/guides/advanced-features/'),
+          to: useUrl('/guides/advanced-features/rspack-start'),
         },
       ],
     },

package/src/i18n/enUS.ts

@@ -27,8 +27,8 @@ export const EN_US = {
   solutions: 'Solutions',
   solutionsDesc1: 'A progressive React framework for web development.',
   solutionsDesc2: 'A powerful solution for npm package development.',
-  solutionsDesc3: 'A documentation site solution with modern tech stack.',
-  solutionsDesc4: 'A Build Engine for web development.',
+  solutionsDesc3: 'A Rspack based documentation site solution.',
+  solutionsDesc4: 'A build engine for web development.',
 
   // Footer
   guide: 'Guide',

package/src/i18n/zhCN.ts

@@ -27,7 +27,7 @@ export const ZH_CN: Record<keyof typeof EN_US, string> = {
   solutions: '解决方案',
   solutionsDesc1: '基于 React 的渐进式 Web 开发框架。',
   solutionsDesc2: '简单、高性能的 npm 包开发方案。',
-  solutionsDesc3: '现代文档站解决方案。',
+  solutionsDesc3: '基于 Rspack 的文档站解决方案。',
   solutionsDesc4: '面向 Web 开发场景的构建引擎。',
 
   // Footer