@modern-js/main-doc 2.57.1 → 2.58.1

package/docs/en/guides/advanced-features/rsbuild-plugin.mdx

@@ -28,26 +28,26 @@ If your current version is lower than MAJOR_VERSION.46.0, you can upgrade by exe
 
 Here are the official Rsbuild plugins built into Modern.js:
 
-| Plugin Name                                                                           | Introduce                                                                                                    | Modern.js Link                                                                                                                        |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
-| [React Plugin](https://rsbuild.dev/plugins/list/plugin-react)                         | Provides support for React                                                                                   | -                                                                                                                                     |
-| [SVGR Plugin](https://rsbuild.dev/plugins/list/plugin-svgr)                           | Support convert SVG to React components                                                                      | [output.disableSvgr](/configure/app/output/disable-svgr)<br />[output.svgDefaultExport](/configure/app/output/svg-default-export)     |
-| [Styled Components Plugin](https://rsbuild.dev/plugins/list/plugin-styled-components) | Provides compile-time support for styled-components                                                          | [tools.styledComponents](/configure/app/tools/styled-components.html)                                                                 |
-| [Assets Retry Plugin](https://rsbuild.dev/plugins/list/plugin-assets-retry)           | Used to automatically resend requests when static assets fail to load                                        | [output.assetsRetry](/configure/app/output/assets-retry.html)                                                                         |
-| [Type Check Plugin](https://rsbuild.dev/plugins/list/plugin-type-check)               | Used to run TypeScript type checker on a separate process                                                    | [output.disableTsChecker](/configure/app/output/disable-ts-checker.html)<br />[tools.tsChecker](/configure/app/tools/ts-checker.html) |
-| [Node Polyfill Plugin](https://rsbuild.dev/plugins/list/plugin-node-polyfill)         | Used to inject polyfills of Node core modules in the browser side                                            | [output.disableNodePolyfill](/configure/app/output/disable-node-polyfill.html)                                                        |
-| [Source Build Plugin](https://rsbuild.dev/plugins/list/plugin-source-build)           | Supports referencing source code from other subdirectories                                                   | [experiments.sourceBuild](/configure/app/experiments/source-build.html)                                                               |
-| [Check Syntax Plugin](https://rsbuild.dev/plugins/list/plugin-check-syntax)           | Used to analyze the syntax compatibility of artifacts                                                        | [security.checkSyntax](/configure/app/security/check-syntax.html)                                                                     |
-| [CSS Minimizer Plugin](https://rsbuild.dev/plugins/list/plugin-css-minimizer)         | Used to customize CSS minimizer, switch to [cssnano](https://cssnano.co/) or other tools for CSS compression | [tools.minifyCss](/configure/app/tools/minify-css.html)                                                                               |
-| [Pug Plugin](https://rsbuild.dev/plugins/list/plugin-pug)                             | Provides support for the Pug template engine                                                                 | [tools.pug](/configure/app/tools/pug.html)                                                                                            |
-| [Rem Plugin](https://rsbuild.dev/plugins/list/plugin-rem)                             | Implements the rem adaptive layout for mobile pages                                                          | [output.convertToRem](/configure/app/output/convert-to-rem.html)                                                                      |
-| [YAML Plugin](https://rsbuild.dev/plugins/list/plugin-yaml)                           | Used to import YAML files and convert them into JavaScript objects                                           | [TOML File](/guides/basic-features/json-files.html#toml-file)                                                                         |
-| [TOML Plugin](https://rsbuild.dev/plugins/list/plugin-toml)                           | Used to import TOML files and convert them into JavaScript objects                                           | [YAML File](/guides/basic-features/json-files.html#yaml-file)                                                                         |
+| Plugin Name                                                                                    | Introduce                                                                                                    | Modern.js Link                                                                                                                        |
+| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
+| [React Plugin](https://rsbuild.dev/plugins/list/plugin-react)                                  | Provides support for React                                                                                   | -                                                                                                                                     |
+| [SVGR Plugin](https://rsbuild.dev/plugins/list/plugin-svgr)                                    | Support convert SVG to React components                                                                      | [output.disableSvgr](/configure/app/output/disable-svgr)<br />[output.svgDefaultExport](/configure/app/output/svg-default-export)     |
+| [Styled Components Plugin](https://github.com/rspack-contrib/rsbuild-plugin-styled-components) | Provides compile-time support for styled-components                                                          | [tools.styledComponents](/configure/app/tools/styled-components.html)                                                                 |
+| [Assets Retry Plugin](https://rsbuild.dev/plugins/list/plugin-assets-retry)                    | Used to automatically resend requests when static assets fail to load                                        | [output.assetsRetry](/configure/app/output/assets-retry.html)                                                                         |
+| [Type Check Plugin](https://rsbuild.dev/plugins/list/plugin-type-check)                        | Used to run TypeScript type checker on a separate process                                                    | [output.disableTsChecker](/configure/app/output/disable-ts-checker.html)<br />[tools.tsChecker](/configure/app/tools/ts-checker.html) |
+| [Node Polyfill Plugin](https://github.com/rspack-contrib/rsbuild-plugin-node-polyfill)         | Used to inject polyfills of Node core modules in the browser side                                            | [output.disableNodePolyfill](/configure/app/output/disable-node-polyfill.html)                                                        |
+| [Source Build Plugin](https://github.com/rspack-contrib/rsbuild-plugin-source-build)           | Supports referencing source code from other subdirectories                                                   | [experiments.sourceBuild](/configure/app/experiments/source-build.html)                                                               |
+| [Check Syntax Plugin](https://github.com/rspack-contrib/rsbuild-plugin-check-syntax)           | Used to analyze the syntax compatibility of artifacts                                                        | [security.checkSyntax](/configure/app/security/check-syntax.html)                                                                     |
+| [CSS Minimizer Plugin](https://github.com/rspack-contrib/rsbuild-plugin-css-minimizer)         | Used to customize CSS minimizer, switch to [cssnano](https://cssnano.co/) or other tools for CSS compression | [tools.minifyCss](/configure/app/tools/minify-css.html)                                                                               |
+| [Pug Plugin](https://github.com/rspack-contrib/rsbuild-plugin-pug)                             | Provides support for the Pug template engine                                                                 | [tools.pug](/configure/app/tools/pug.html)                                                                                            |
+| [Rem Plugin](https://github.com/rspack-contrib/rsbuild-plugin-rem)                                      | Implements the rem adaptive layout for mobile pages                                                          | [output.convertToRem](/configure/app/output/convert-to-rem.html)                                                                      |
+| [YAML Plugin](https://github.com/rspack-contrib/rsbuild-plugin-yaml)                           | Used to import YAML files and convert them into JavaScript objects                                           | [TOML File](/guides/basic-features/json-files.html#toml-file)                                                                         |
+| [TOML Plugin](https://github.com/rspack-contrib/rsbuild-plugin-toml)                           | Used to import TOML files and convert them into JavaScript objects                                           | [YAML File](/guides/basic-features/json-files.html#yaml-file)                                                                         |
 
 ### Un-builtin Plugins
 
 Here are the official Rsbuild plugins that are not built into Modern.js:
 
-- [Image Compress Plugin](https://rsbuild.dev/plugins/list/plugin-image-compress): Compress the image resources used in the project.
+- [Image Compress Plugin](https://github.com/rspack-contrib/rsbuild-plugin-image-compress): Compress the image resources used in the project.
 - [Stylus Plugin](https://rsbuild.dev/plugins/list/plugin-stylus): Use Stylus as the CSS preprocessor.
-- [UMD Plugin](https://rsbuild.dev/plugins/list/plugin-umd): Used to build outputs in UMD format.
+- [UMD Plugin](https://github.com/rspack-contrib/rsbuild-plugin-umd): Used to build outputs in UMD format.

package/docs/en/guides/advanced-features/ssr/_meta.json

@@ -0,0 +1,5 @@
+[
+  "usage",
+  "stream",
+  "cache"
+]

package/docs/en/guides/basic-features/_meta.json

@@ -0,0 +1,22 @@
+[
+  "css",
+  "routes",
+  {
+    "type": "dir",
+    "name": "data",
+    "label": "data-solution",
+    "collapsed": true
+  },
+  "alias",
+  "mock",
+  "proxy",
+  "env-vars",
+  "html",
+  "output-files",
+  "static-assets",
+  "svg-assets",
+  "json-files",
+  "wasm-assets",
+  "css-modules",
+  "deploy"
+]

package/docs/en/guides/basic-features/data/_meta.json

@@ -0,0 +1,4 @@
+[
+  "data-fetch",
+  "data-write"
+]

package/docs/en/guides/concept/_meta.json

@@ -0,0 +1,4 @@
+[
+  "entries",
+  "builder"
+]

package/docs/en/guides/{deprecat.md → deprecated.md}

@@ -2,7 +2,7 @@
 sidebar_position: 10
 ---
 
-# Deprecated Functions
+# Deprecated
 
 This article will introduce the functions that were previously supported by Modern.js, but have now been deprecated, along with the recommended alternatives.
 

package/docs/en/guides/get-started/_meta.json

@@ -0,0 +1,7 @@
+[
+  "introduction",
+  "quick-start",
+  "upgrade",
+  "glossary",
+  "tech-stack"
+]

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

@@ -93,7 +93,7 @@ $ pnpm run build
 
 > modern build
 
-  Modern.js Framework v2.55.0
+  Modern.js Framework
 
 info    Starting production build...
 info    Type checker is enabled. It may take some time.
@@ -141,7 +141,7 @@ $ pnpm run serve
 
 > modern serve
 
-  Modern.js Framework v2.55.0
+  Modern.js Framework
 
 info    Starting production server...
 

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

@@ -18,7 +18,7 @@ import { PackageManagerTabs } from '@theme';
 > modern upgrade
 
 [INFO] [Project Type]: Web App
-[INFO] [Modern.js Latest Version]: 2.0.0
+[INFO] [Modern.js Latest Version]: x.y.z
 [INFO] Upgrade Modern.js package version success!
 ```
 

package/docs/en/guides/topic-detail/_meta.json

@@ -0,0 +1,26 @@
+[
+  {
+    "type": "dir",
+    "name": "micro-frontend",
+    "label": "micro-frontend",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "framework-plugin",
+    "label": "framework-plugin",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "model",
+    "label": "reduck",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "generator",
+    "label": "generator",
+    "collapsed": true
+  }
+]

package/docs/en/guides/topic-detail/framework-plugin/_meta.json

@@ -0,0 +1,10 @@
+[
+  "introduction",
+  "lifecycle",
+  "hook",
+  "implement",
+  "relationship",
+  "extend",
+  "plugin-api",
+  "hook-list"
+]

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

@@ -674,17 +674,17 @@ export const myPlugin = (): ServerPlugin => ({
 ## Runtime
 
 :::note
-The Runtime plugin is currently not fully opened, and the API is not guaranteed to be stable. Use with caution.
+Currently, the Runtime plugin is not fully open, and the API does not guarantee stability. Use with caution.
 :::
 
-The Runtime plugin is mainly used for developers to modify the component that need to be rendered.
+The Runtime plugin is mainly used by developers to add behaviors before application rendering and to modify components that need to be rendered.
 
-### `init`
+### `beforeRender`
 
-- Function: Executes `App.init`.
+- Function: Add behaviors before application rendering
 - Execution stage: Rendering (SSR/CSR).
-- Hook model: `AsyncPipeline`
-- Type: `AsyncPipeline<{ context: RuntimeContext; }, unknown>`
+- Hook model: `AsyncWorkflow`
+- Type: `AsyncWorkflow<RuntimeContext, void>`
 - Example:
 
 ```ts
@@ -693,27 +693,22 @@ import type { Plugin } from '@modern-js/runtime';
 export const myPlugin = (): Plugin => ({
   setup(api) {
     return {
-      init({ context }, next) {
+      beforeRender(context) {
         // do something
-        return next({ context });
       },
     };
   },
 });
 ```
 
-### `hoc`
+### `wrapRoot`
 
-- Function: Modifies the components that need to be rendered.
+- Function: Modify components that need to be rendered
 - Execution stage: Rendering (SSR/CSR).
-- Hook model: `Pipeline`
-- Type: `Pipeline<{ App: React.ComponentType<any>;config: Record<string, any>; },React.ComponentType<any>>`
+- Hook model: `Waterfall`
+- Type: `Waterfall<React.ComponentType<any>>`
 - Example:
 
-:::note
-When using the hoc hook, you need to copy the static properties of the original App component to the new component and pass through the props.
-:::
-
 ```ts
 import { createContext } from 'react';
 import type { Plugin } from '@modern-js/runtime';
@@ -722,18 +717,15 @@ export const myPlugin = (): Plugin => ({
   setup(api) {
     const FooContext = createContext('');
     return {
-      hoc({ App, config }, next) {
+      wrapRoot(App) {
         const AppWrapper = (props: any) => {
           return (
-            <FooContext.Provider store={'test'}>
+            <FooContext.Provider value={'test'}>
               <App {...props} />
             </FooContext.Provider>
           );
         };
-        return next({
-          App: AppWrapper,
-          config
-        });
+        return AppWrapper;
       },
     };
   },

package/docs/en/guides/topic-detail/generator/_meta.json

@@ -0,0 +1,17 @@
+[
+  {
+    "type": "dir",
+    "name": "create",
+    "label": "@modern-js/create"
+  },
+  {
+    "type": "dir",
+    "name": "new",
+    "label": "new-command"
+  },
+  {
+    "type": "dir",
+    "name": "plugin",
+    "label": "generator-plugin"
+  }
+]

package/docs/en/guides/topic-detail/generator/create/_meta.json

@@ -0,0 +1,5 @@
+[
+  "use",
+  "option",
+  "config"
+]

package/docs/en/guides/topic-detail/generator/new/_meta.json

@@ -0,0 +1,5 @@
+[
+  "use",
+  "option",
+  "config"
+]

package/docs/en/guides/topic-detail/generator/plugin/_meta.json

@@ -0,0 +1,11 @@
+[
+  "structure",
+  "category",
+  "use",
+  "context",
+  {
+    "type": "dir",
+    "name": "api",
+    "label": "API"
+  }
+]

package/docs/en/guides/topic-detail/model/_meta.json

@@ -0,0 +1,14 @@
+[
+  "quick-start",
+  "define-model",
+  "use-model",
+  "computed-state",
+  "manage-effects",
+  "auto-actions",
+  "model-communicate",
+  "performance",
+  "typescript-best-practice",
+  "redux-integration",
+  "use-out-of-modernjs",
+  "faq"
+]

package/docs/en/guides/troubleshooting/_meta.json

@@ -0,0 +1,6 @@
+[
+  "dependencies",
+  "cli",
+  "builder",
+  "hmr"
+]

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

@@ -18,8 +18,8 @@ For example, running `npm ls @modern-js/core` will show the following result:
 
 ```
 project
-└─┬ @modern-js/app-tools@2.0.0
-  └── @modern-js/core@2.0.0
+└─┬ @modern-js/app-tools@x.y.z
+  └── @modern-js/core@x.y.z
 ```
 
 **pnpm**
@@ -30,8 +30,8 @@ For example, running `pnpm ls @modern-js/core --depth Infinity` will show the fo
 
 ```
 devDependencies:
-@modern-js/app-tools 2.0.0
-└── @modern-js/core 2.0.0
+@modern-js/app-tools x.y.z
+└── @modern-js/core x.y.z
 ```
 
 ---

package/docs/en/tutorials/_meta.json

@@ -0,0 +1,17 @@
+[
+  {
+    "type": "dir",
+    "name": "foundations",
+    "label": "foundations"
+  },
+  {
+    "type": "dir",
+    "name": "first-app",
+    "label": "first-app"
+  },
+  {
+    "type": "dir",
+    "name": "examples",
+    "label": "examples"
+  }
+]

package/docs/zh/_meta.json

@@ -0,0 +1,27 @@
+[
+  {
+    "text": "guide",
+    "link": "/guides/get-started/introduction",
+    "activeMatch": "/guides/"
+  },
+  {
+    "text": "tutorials",
+    "link": "/tutorials/foundations/introduction",
+    "activeMatch": "/tutorials/"
+  },
+  {
+    "text": "configure",
+    "link": "/configure/app/usage",
+    "activeMatch": "/configure/"
+  },
+  {
+    "text": "apis",
+    "link": "/apis/app/commands",
+    "activeMatch": "/apis/"
+  },
+  {
+    "text": "community",
+    "link": "/community/showcase",
+    "activeMatch": "/community/"
+  }
+]

package/docs/zh/apis/_meta.json

@@ -0,0 +1,13 @@
+[
+  "app/commands",
+  {
+    "type": "dir",
+    "name": "app/hooks",
+    "label": "file-conventions"
+  },
+  {
+    "type": "dir",
+    "name": "app/runtime",
+    "label": "runtime-api"
+  }
+]

package/docs/zh/apis/app/commands.mdx

@@ -200,7 +200,7 @@ Usage: modern inspect [options]
 
 Options:
   --env <env>           查看指定环境下的配置 (default: "development")
-  --output <output>     指定在 dist 目录下输出的路径 (default: "/")
+  --output <output>     指定在 dist 目录下输出的路径 (default: "./")
   --verbose             在结果中展示函数的完整内容
   -c --config <config>  指定配置文件路径，可以为相对路径或绝对路径
   -h, --help            显示命令帮助

package/docs/zh/apis/app/hooks/_meta.json

@@ -0,0 +1,28 @@
+[
+  {
+    "type": "dir",
+    "name": "src",
+    "label": "src/",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "api",
+    "label": "api/",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "server",
+    "label": "server/",
+    "collapsed": true
+  },
+  "shared",
+  {
+    "type": "dir",
+    "name": "config",
+    "label": "config/",
+    "collapsed": true
+  },
+  "modern-config"
+]

package/docs/zh/apis/app/runtime/_meta.json

@@ -0,0 +1,50 @@
+[
+  {
+    "type": "dir",
+    "name": "core",
+    "label": "Core",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app",
+    "label": "App",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "router",
+    "label": "Router",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "model",
+    "label": "Model",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "ssr",
+    "label": "SSR",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "bff",
+    "label": "BFF",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "web-server",
+    "label": "Web Server",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "utility",
+    "label": "Utility",
+    "collapsed": true
+  }
+]

package/docs/zh/community/_meta.json

@@ -0,0 +1,11 @@
+[
+  "showcase",
+  "team",
+  "releases",
+  "contributing-guide",
+  {
+    "type": "dir",
+    "name": "blog",
+    "label": "blog"
+  }
+]

package/docs/zh/community/blog/_meta.json

@@ -0,0 +1,6 @@
+[
+  "overview",
+  "v2-release-note",
+  "2022-0910-updates",
+  "2022-0708-updates"
+]

package/docs/zh/community/blog/v2-release-note.mdx

@@ -1,6 +1,5 @@
 ---
-sidebar_label: Modern.js v2 发布
-sidebar_position: 97
+title: Modern.js v2 发布
 ---
 
 # Modern.js v2 发布：支持 Rspack 构建

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

@@ -5,7 +5,7 @@ $ pnpm run dev
 
 > modern dev
 
-  Modern.js Framework v2.55.0
+  Modern.js Framework
 
 ready   Client compiled in 0.86 s
 

package/docs/zh/configure/_meta.json

@@ -0,0 +1,78 @@
+[
+  "app/usage",
+  {
+    "type": "dir",
+    "name": "app/dev",
+    "label": "dev",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/bff",
+    "label": "bff",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/html",
+    "label": "html",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/tools",
+    "label": "tools",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/source",
+    "label": "source",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/server",
+    "label": "server",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/output",
+    "label": "output",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/deploy",
+    "label": "deploy",
+    "collapsed": true
+  },
+  "app/plugins",
+  {
+    "type": "dir",
+    "name": "app/security",
+    "label": "security",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/runtime",
+    "label": "runtime",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/performance",
+    "label": "performance",
+    "collapsed": true
+  },
+  {
+    "type": "dir",
+    "name": "app/experiments",
+    "label": "experiments",
+    "collapsed": true
+  },
+  "app/builder-plugins",
+  "app/auto-load-plugin"
+]

package/docs/zh/configure/app/auto-load-plugin.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 22
 ---
 
-# autoLoadPlugins 自动注册插件
+# autoLoadPlugins
 
 - **类型：** `boolean`
 - **默认值：** `false`

package/docs/zh/configure/app/bff/prefix.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_label: prefix
+title: prefix
 ---
 
 # bff.prefix

package/docs/zh/configure/app/builder-plugins.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 21
 ---
 
-# builderPlugins 构建插件
+# builderPlugins
 
 - **类型：** `RsbuildPlugin[]`
 - **默认值：** `[]`