@modern-js/main-doc 2.34.0 → 2.35.1

package/docs/en/guides/get-started/glossary.mdx

@@ -64,7 +64,7 @@ With SSR, the server generates HTML that already contains dynamic content and se
 
 SSG stands for "Static Site Generation". It means that web pages are pre-rendered as static HTML and served directly to the client, without the need for the server to generate HTML in real-time.
 
-In traditional SSR, the server generates HTML in real-time every time a user requests a page. With SSG, HTML can be generated in advance during the build process and hosted on a CDN or other static resource service.
+In traditional SSR, the server generates HTML in real-time every time a user requests a page. With SSG, HTML can be generated in advance during the build process and hosted on a CDN or other static assets service.
 
 Compared to traditional SSR, SSG can provide faster loading speeds and less server-side overhead, as there is no need to maintain a server to generate HTML in real-time. However, SSG is not suitable for websites that require dynamic content, as the HTML is generated during the build process and does not support real-time updates.
 

package/docs/en/guides/get-started/introduction.mdx

@@ -66,6 +66,26 @@ It mainly includes the following features:
 - 🌏 **Ecology**: Self-developed state management, micro-frontend, module packaging, Monorepo solutions, and other peripheral needs.
 - 🕸 **Routing Modes**: Includes self-controlled routing, file-convention-based routing (nested routing), etc.
 
-## Next
+## Comparison with Others
+
+### Next.js
+
+Next.js is one of the most popular React frameworks in the community. It is developed by Vercel.
+
+Next.js defaults to using React Server Components, which means **you will need to render your web application on the server and pay for the server-side rendering costs**. In addition, Server Components is not yet a stable technology, and many popular React libraries in the community have not yet finished adapting to RSC. At this stage, you may need to use the Next.js's Pages Router to avoid issues caused by Server Components.
+
+If you want to build a single-page application (SPA) and render it on the client side, Next.js may not be the best choice because many of its features are designed around server-first principles. If you need to use client-side rendering, you can only use limited functionality through Next.js's "static exports" feature.
+
+On the other hand, Modern.js considers both client-side rendering (CSR) and server-side rendering (SSR) to be equally important. When you build a Modern.js application, it defaults to client-side rendering, and you don't need to understand the uses and limitations of Server Components. You can also enable SSR whenever you need it, and even enable SSR for specific pages. The whole process is fully progressive. Please note that Modern.js does not currently support Server Components. We will continue to monitor its potential and provide support when appropriate.
+
+### Umi
+
+Umi is a popular React framework in the Chinese community and serves as the underlying frontend framework for the Ant Group. Modern.js and Umi share many similarities, such as support for plugin system, convention-based routing, and micro-generators.
+
+**The main difference between Modern.js and Umi is their approach to optimizing build speed**. Umi uses MFSU technology to improve build speed, while Modern.js uses Rspack to achieve 5 to 10 times faster build speed. From our perspective, Rust tools like Rspack are more in line with the long-term evolution of the front-end toolchain, as they can strike a good balance between performance, stability, and ecosystem compatibility.
+
+In addition, Modern.js provides richer server-side features, including comprehensive SSR capabilities, integrated BFF development capabilities, and support for custom web servers. These capabilities have been extensively validated by ByteDance in numerous online applications and can be directly used in production environments.
+
+## Next Step
 
 If you want to learn how to use the Modern.js framework, you can try to [create your first application](/tutorials/first-app/c01-start), or read the [Quick Start](/guides/get-started/quick-start) guide.

package/docs/en/guides/get-started/quick-start.mdx

@@ -91,23 +91,15 @@ $ pnpm run build
 
 > modern build
 
-info    Create a production build...
-
-info    File sizes after production build:
+info    Staring production build...
+ready   Client compiled in 50ms
+info    Production file sizes:
 
   File                                      Size         Gzipped
-  dist/static/js/lib-corejs.ffeb7fb8.js     214.96 kB    67.23 kB
-  dist/static/js/lib-react.09721b5c.js      152.61 kB    49.02 kB
-  dist/static/js/218.102e2f39.js            85.45 kB     28.5 kB
-  dist/static/js/lib-babel.a7bba875.js      11.93 kB     3.95 kB
-  dist/html/main/index.html                 5.84 kB      2.57 kB
-  dist/static/js/main.3568a38e.js           3.57 kB      1.44 kB
-  dist/static/css/async/304.c3c481a5.css    2.62 kB      874 B
-  dist/asset-manifest.json                  1.48 kB      349 B
-  dist/static/js/async/304.c45706bc.js      1.4 kB       575 B
-  dist/static/js/async/509.fcb06e14.js      283 B        230 B
-
- Client ✔ done in 3.57s
+  dist/static/js/lib-react.09721b5c.js      152.6 kB     49.0 kB
+  dist/html/main/index.html                 5.8 kB       2.5 kB
+  dist/static/js/main.3568a38e.js           3.5 kB       1.4 kB
+  dist/static/css/main.03221f72.css         1.4 kB       741 B
 ```
 
 By default, the build artifacts are generated in `dist/`, with the following directory structure:
@@ -135,8 +127,7 @@ $ pnpm run serve
 
 > modern serve
 
-Starting the modern server...
-info    App running at:
+info    Starting production server...
 
   > Local:    http://localhost:8080/
   > Network:  http://192.168.0.1:8080/

package/docs/en/guides/get-started/tech-stack.mdx

@@ -0,0 +1,138 @@
+---
+sidebar_position: 4
+---
+
+# Tech Stack
+
+The Modern.js framework comes with built-in popular libraries and development tools from the community.
+
+In this document, you can learn about the main technology stack involved in the Modern.js framework, as well as some optional libraries and tools.
+
+---
+
+## UI Library
+
+Modern.js uses [React 18](https://react.dev/) to build user interfaces and is also compatible with React 17.
+
+The underlying Builder of Modern.js also supports building Vue applications. If you need to use Vue, you can refer to ["Building Vue App"](https://modernjs.dev/builder/en/guide/framework/vue3.html).
+
+---
+
+## Routing
+
+Modern.js uses [React Router 6](https://reactrouter.com/en/main) for routing and is also compatible with React Router 5.
+
+Modern.js supports conventional routing, self-controlled routing, or other routing schemes. Please refer to ["Routing"](/en/guides/basic-features/routes) to make your choice.
+
+---
+
+## Micro Frontends
+
+Modern.js provides out-of-the-box support for the [Garfish](https://www.garfishjs.org/) micro frontend framework.
+
+We are also working with Zack Jackson, the author of [Module Federation](https://webpack.js.org/concepts/module-federation/), to provide a more comprehensive solution.
+
+---
+
+## State Management
+
+Modern.js can be used with any community state management library, such as [Redux](https://redux.js.org/), [Jotai](https://jotai.org/), [Zustand](https://docs.pmnd.rs/zustand), [Valtio](https://valtio.pmnd.rs/), and more.
+
+Modern.js also provides a wrapper around Redux called Reduck for state management. You can refer to ["Reduck State Management"](/en/guides/topic-detail/model/quick-start) for usage.
+
+---
+
+## Package Manager
+
+Modern.js can be used with any community package manager, such as [npm](https://www.npmjs.com/package/npm), [yarn](https://classic.yarnpkg.com/lang/en/), [pnpm](https://pnpm.io/), or [Bun](https://bun.sh/).
+
+We recommend using pnpm for faster installation speed.
+
+---
+
+## Bundler
+
+Modern.js uses [Webpack 5](https://webpack.js.org/) or [Rspack](https://www.rspack.dev/) to bundle your web applications.
+
+The default bundler used is Webpack 5. You can refer to ["Using Rspack"](/en/guides/advanced-features/rspack-start) to switch to the faster Rspack.
+
+---
+
+## Transpiler
+
+Modern.js uses [Babel](https://babeljs.io/), [SWC](https://swc.rs/), or [esbuild](https://esbuild.github.io/) as JavaScript transpiler to transform TypeScript or JSX into JavaScript code that can run in browsers and perform syntax downgrades.
+
+- When using Webpack for bundling, the default tool is Babel, which can be switched to SWC or esbuild.
+- When using Rspack for bundling, the default tool is SWC, which can be switched to Babel.
+
+---
+
+## Minimizer
+
+During production builds, Modern.js uses [Terser](https://github.com/terser/terser), [SWC](https://swc.rs/), or [esbuild](https://esbuild.github.io/) to minify JavaScript code, and [cssnano](https://cssnano.co/) to minify CSS code.
+
+- When using Webpack for bundling, the default tool for minifying JS code is Terser, which can be switched to SWC or esbuild.
+- When using Rspack for bundling, the default tool for minifying JS code is SWC, and switching to other tools is not currently supported.
+
+---
+
+## CSS Transformer
+
+Modern.js uses [PostCSS](https://postcss.org/) to transform CSS code and enables [autoprefixer](https://github.com/postcss/autoprefixer) by default to add CSS prefixes.
+
+Modern.js supports enabling ["Tailwind CSS"](/en/guides/basic-features/css.html#using-tailwind-css) and is compatible with both Tailwind CSS v2 and v3.
+
+---
+
+## CSS Preprocessors
+
+Modern.js supports three CSS preprocessors: [Sass](https://sass-lang.com/), [Less](https://lesscss.org/), and [Stylus](https://stylus-lang.com/):
+
+- Sass and Less are supported by default and ready to use.
+- Stylus is optional and can be used by referring to the ["Stylus Plugin"](https://modernjs.dev/builder/en/plugins/plugin-stylus.html).
+
+---
+
+## CSS Modules
+
+Modern.js provides out-of-the-box support for [CSS Modules](https://github.com/css-modules/css-modules), which is implemented internally based on [css-loader](https://www.npmjs.com/package/css-loader).
+
+Please refer to ["Use CSS Modules"](https://modernjs.dev/builder/en/guide/basic/css-modules.html) for usage instructions.
+
+---
+
+## CSS-in-JS
+
+Modern.js supports the use of [styled-components](https://styled-components.com/). Please refer to ["Using CSS-in-JS"](/en/guides/basic-features/css.html#using-css-in-js) for usage instructions.
+
+If you need to use other CSS-in-JS solutions, you can integrate them into your project on your own.
+
+---
+
+## Testing Framework
+
+Modern.js supports the use of [Jest](https://jestjs.io/) for unit testing or integration testing. This feature is optional. Please refer to ["Using Jest"](/en/guides/advanced-features/testing) to enable it.
+
+If you need to use [Vitest](https://vitest.dev/) or other testing frameworks, you can integrate them into your project on your own.
+
+---
+
+## UI Components
+
+Modern.js can be used with any React UI component library from the community, such as [MUI](https://mui.com/), [Ant Design](https://ant.design/), [Arco Design](https://github.com/arco-design/arco-design), [Semi Design](https://semi.design/), [Radix UI](https://www.radix-ui.com/), and more.
+
+Additionally, Modern.js provides built-in support for [on-demand import](/configure/app/source/transform-import) of Ant Design and Arco Design.
+
+---
+
+## Component Development
+
+Modern.js supports the use of [Storybook](https://storybook.js.org/) for developing UI components. This feature is optional. Please refer to ["Using Storybook"](/en/guides/advanced-features/using-storybook) to enable it.
+
+---
+
+## Node.js Framework
+
+import TechStackNodeFramework from '@site-docs-en/components/tech-stack-node-framework';
+
+<TechStackNodeFramework />

package/docs/en/guides/get-started/upgrade.mdx

@@ -8,11 +8,13 @@ sidebar_position: 3
 
 Modern.js provides the `upgrade` command to support upgrading the project to the latest version of Modern.js.
 
-Run `pnpm run upgrade` in the project:
+Run the `upgrade` script in the project:
 
-```bash
-$ pnpm run upgrade
+import { PackageManagerTabs } from '@theme';
+
+<PackageManagerTabs command="run upgrade" />
 
+```bash
 > modern upgrade
 
 [INFO] [Project Type]: Web App
@@ -22,11 +24,15 @@ $ pnpm run upgrade
 
 You can see that the dependencies in the project's `package.json` have been updated to the latest version.
 
+:::tip
+If the `upgrade` command is not declared in the project's `package.json`, you can execute `npx modern upgrade` as an equivalent alternative.
+:::
+
 ## Upgrade to a specified version
 
 All packages of Modern.js are currently released with a **uniform version number**.
 
-import ReleaseNote from "@site-docs-en/components/release-note"
+import ReleaseNote from '@site-docs-en/components/release-note';
 
 <ReleaseNote />
 

package/docs/en/guides/topic-detail/changesets/add.mdx

@@ -22,7 +22,7 @@ A changeset includes:
 The following example commands are all using pnpm. If you need to use other package managers, please replace them as needed.
 :::
 
-### NPM Module
+### Modern.js Module
 
 #### Run the change command in the root directory:
 

package/docs/en/guides/topic-detail/changesets/changelog.mdx

@@ -160,11 +160,11 @@ Configure `changlog` as `./my-changelog-config.js`:
 }
 ```
 
-### Using Npm Module
+### Using Modern.js Module
 
-Customizing changelog can also be managed using the NPM module project to provide a common solution.
+Customizing changelog can also be managed using the Modern.js Module to provide a common solution.
 
-#### Use `npx @modern-js/create@latest` to create a module project.
+#### Use `npx @modern-js/create@latest` to create a Modern.js Module.
 
 ```md
 ? Please select the type of project you want to create: Npm Module

package/docs/en/guides/topic-detail/changesets/commit.mdx

@@ -191,11 +191,11 @@ Configure `commit` as `./my-commit-config.js`:
 }
 ```
 
-### Using NPM Module
+### Using Modern.js Module
 
-Customizing commit can also be managed using the NPM module project to provide a common solution.
+Customizing commit can also be managed using the Modern.js Module to provide a common solution.
 
-#### Use `npx @modern-js/create@latest` to create a module project
+#### Use `npx @modern-js/create@latest` to create a mModern.js Module
 
 ```md
 ? Please select the type of project you want to create: Npm Module

package/docs/en/guides/topic-detail/changesets/release-note.mdx

@@ -204,11 +204,11 @@ You can also define the command parameters directly in `package.json`:
 
 Run the command `pnpm run gen-release-note` directly.
 
-### Using NPM Module
+### Using Modern.js Module
 
-Customizing release note can also be managed using the NPM module project to provide a common solution.
+Customizing release note can also be managed using the Modern.js Module to provide a common solution.
 
-#### Use `npx @modern-js/create@latest` to create a module project
+#### Use `npx @modern-js/create@latest` to create a Modern.js Module
 
 ```md
 ? Please select the type of project you want to create: Npm Module

package/docs/en/guides/topic-detail/changesets/release.mdx

@@ -13,7 +13,7 @@ The following example commands are all using pnpm. If you need to use other pack
 
 :::
 
-### Npm Module
+### Modern.js Module
 
 #### Run the bump command in the root directory
 

package/docs/en/guides/topic-detail/framework-plugin/implement.mdx

@@ -33,7 +33,7 @@ In addition, plugins allow configuration of the execution order with other plugi
 
 ### Plugin Types
 
-Modern.js supports various types of project development, such as application development (`app-tools`), module development (`module-tools`), etc.
+Modern.js supports various types of project development, such as application development (Modern.js Framework), module development (Modern.js Module), etc.
 
 To balance the differences and commonalities between various types of project development, Modern.js organizes plugins as shown in the following figure:
 
@@ -170,6 +170,8 @@ export const myPlugin = (): CliPlugin => ({
 });
 ```
 
+Note that the setup function of the next plugin is not executed until the async setup function of the current plugin has finished. Therefore, you should avoid performing time-consuming asynchronous operations in the setup function to avoid slowing down the startup performance of the CLI.
+
 ## Adding Plugins
 
 Custom plugins can be used by following the instructions in the [plugins](/configure/app/plugins) section of the documentation. Below is the recommended way to implement plugins in Modern.js.
@@ -203,9 +205,9 @@ export default defineConfig({
 
 ### Publishing a Plugin on npm
 
-If you want to publish your Modern.js plugin on npm, it's recommended to use the module project solution provided by Modern.js to manage and build the plugin.
+If you want to publish your Modern.js plugin on npm, it's recommended to use the [Modern.js Module](https://modernjs.dev/module-tools) to manage and build the plugin.
 
-First, create an empty module project solution and adjust the package name:
+First, create an empty Modern.js Module project and adjust the package name:
 
 ```json
 {
@@ -214,7 +216,7 @@ First, create an empty module project solution and adjust the package name:
 }
 ```
 
-create plugin main file:
+Create plugin main file:
 
 ```ts title=src/index.ts
 import type { CliPlugin } from '@modern-js/core';

package/docs/en/guides/topic-detail/generator/create/use.mdx

@@ -48,19 +48,11 @@ npx @modern-js/create@latest npm-module
 ? Please select the package manager: pnpm
 ```
 
-### Create a Modern Doc Project
-
-```bash
-npx @modern-js/create@latest doc-website
-? Please select the type of project you want to create: Doc Site
-? Please select the package manager: pnpm
-```
-
 ### Create Monorepo Project
 
 ```bash
 npx @modern-js/create@latest monorepo
-? Please select the type of project you want to create: Doc Site
+? Please select the type of project you want to create: Monorepo
 ? Please select the package manager: pnpm
 ```
 

package/docs/en/guides/topic-detail/generator/plugin/context.md

@@ -25,7 +25,7 @@ Only some APIs are briefly explained below. For the complete API, please refer t
 
 ## Customize Input
 
-Both Modern.js Web App and Npm Module schemes have default input interactions. These APIs can be used to add, modify, hide, and provide default values for these inputs.
+Both Modern.js Framework and Modern.js Module have default input interactions. These APIs can be used to add, modify, hide, and provide default values for these inputs.
 
 For example:
 

package/docs/en/guides/topic-detail/micro-frontend/c01-introduction.mdx

@@ -2,6 +2,7 @@
 sidebar_position: 1
 title: Introduction
 ---
+
 # Introduction
 
 import MicroFrontend from '@modern-js/builder-doc/docs/en/shared/micro-frontend.md';

package/docs/en/guides/topic-detail/micro-frontend/c02-development.mdx

@@ -13,6 +13,7 @@ Through this chapter you can learn:
 ## Create an app
 
 Currently supports two routing modes
+
 - Self-controlled routing
 - Conventional routing
 
@@ -20,7 +21,6 @@ First, clarify the routing mode of the main application [create a file-based rou
 
 In this experience we will create two sub-applications Table and Dashboard for the main application (Table is reduced routing, Dashboard is self-controlled routing)
 
-
 ### File-based Routing Main App
 
 Initialize the project with a command line:
@@ -39,11 +39,12 @@ After the project is created, we can enable the `micro frontend` through `pnpm r
 
 Next, let's register the micro frontend plugin and add the main micro frontend app and add the list of sub-apps:
 
-import EnableMicroFrontend from "@site-docs-en/components/enable-micro-frontend";
+import EnableMicroFrontend from '@site-docs-en/components/enable-micro-frontend';
 
 <EnableMicroFrontend />
 
 Then we create two new directories in the routes folder
+
 - table (for loading conventional routing sub-applications)
 - dashboard (for loading self-controlled routing sub-applications)
 
@@ -61,8 +62,8 @@ const Index = () => {
     <div>
       <Table />
     </div>
-  )
-}
+  );
+};
 
 export default Index;
 ```
@@ -79,11 +80,12 @@ const Index = () => {
     <div>
       <Dashboard />
     </div>
-  )
-}
+  );
+};
 
 export default Index;
 ```
+
 #### route link
 
 At this time, the main application configuration has been completed, and the sub-application can be loaded through the route, and the `layout.tsx` of the main application can be modified to jump to the route:
@@ -93,9 +95,15 @@ import { Outlet, Link } from '@modern-js/runtime/router';
 
 const Layout = () => (
   <div>
-    <div><Link to={'/table'}>Load file-base routing sub-app</Link></div>
-    <div><Link to={'/dashboard'}>Load self-controlled routing sub-app</Link></div>
-    <div><Link to={'/'}>unmount sub-app</Link></div>
+    <div>
+      <Link to={'/table'}>Load file-base routing sub-app</Link>
+    </div>
+    <div>
+      <Link to={'/dashboard'}>Load self-controlled routing sub-app</Link>
+    </div>
+    <div>
+      <Link to={'/'}>unmount sub-app</Link>
+    </div>
     <Outlet />
   </div>
 );
@@ -127,7 +135,7 @@ Since it is a self-controlled route, we delete the `routes/` folder and add the
 
 #### Load sub-app
 
-import CustomRouterMicroFrontend from "@site-docs-en/components/custom-router-micro-frontend";
+import CustomRouterMicroFrontend from '@site-docs-en/components/custom-router-micro-frontend';
 
 <CustomRouterMicroFrontend />
 
@@ -155,7 +163,7 @@ import { garfishPlugin } from '@modern-js/plugin-garfish';
 
 export default defineConfig({
   dev: {
-    port: 8081
+    port: 8081,
   },
   runtime: {
     router: true,
@@ -172,10 +180,8 @@ add `src/routes/page.tsx`:
 
 ```js title="src/routes/page.tsx"
 const Index = () => {
-  return (
-    <div className="container-box">subApp</div>
-  )
-}
+  return <div className="container-box">subApp</div>;
+};
 
 export default Index;
 ```
@@ -204,7 +210,7 @@ import { garfishPlugin } from '@modern-js/plugin-garfish';
 
 export default defineConfig({
   dev: {
-    port: 8082
+    port: 8082,
   },
   runtime: {
     router: true,
@@ -224,7 +230,7 @@ And add code in `src/App.tsx`, note that you need to parse from `props` and pass
 ```js title="src/App.tsx"
 import { BrowserRouter, Route, Routes } from '@modern-js/runtime/router';
 
-export default (props: {basename: string}) => {
+export default (props: { basename: string }) => {
   const { basename } = props;
 
   return (
@@ -241,6 +247,7 @@ export default (props: {basename: string}) => {
 ## Debug
 
 Start the application by executing the `pnpm run dev` command in the directory in sequence:
+
 - masterApp `http://localhost:8080`
 - table subapplication (conventional routing) `http://localhost:8081`
 - dashboard subapplication (self-controlled routing) `http://localhost:8082`