@modern-js/module-tools-docs 2.67.7 → 2.67.8

package/CHANGELOG.md

@@ -1,5 +1,7 @@
 # @modern-js/module-tools-docs
 
+## 2.67.8
+
 ## 2.67.7
 
 ## 2.67.6

package/docs/en/guide/basic/command-preview.md

@@ -24,7 +24,7 @@ Options:
   -h, --help Show information about the current command
 ```
 
-Modern.js Module supports the `platform` build mode, which can be used to execute build tasks of other tools. Currently, the official support includes [Rspress](https://rspress.dev/). For example, you can start the doc build task to generate doc products by executing the `modern build --platform` commands.
+Modern.js Module supports the `platform` build mode, which can be used to execute build tasks of other tools. Currently, the official support includes [Rspress](https://rspress.rs/). For example, you can start the doc build task to generate doc products by executing the `modern build --platform` commands.
 
 ## `modern new`
 
@@ -66,7 +66,7 @@ Commands:
 
 The Modern.js Module provides the ability to use debugging tools, which can be started with the `modern dev` command. Note, however, that no debugging-related plugins are provided by default, so executing `modern dev` will prompt: _"No dev tools found available "_.
 
-The officially supported debugging tool is [Rspress](https://rspress.dev/), so you can run `modern dev` or `modern dev doc` to execute it after you run `modern new` to enable it.
+The officially supported debugging tool is [Rspress](https://rspress.rs/), so you can run `modern dev` or `modern dev doc` to execute it after you run `modern new` to enable it.
 
 ## `modern change`
 

package/docs/en/guide/basic/use-module-doc.mdx

@@ -17,7 +17,7 @@ This chapter describes how to quickly build a static documentation site for a mo
 ### Preliminary preparation
 
 1. Enable the documentation feature via [micro-generator](/guide/basic/use-micro-generator).
-2. Read [Introduction to Rspress](https://rspress.dev/guide/start/introduction.html).
+2. Read [Introduction to Rspress](https://rspress.rs/guide/start/introduction.html).
 
 After finishing the preparation work, we will build a documentation site for the module project based on Rspress.
 
@@ -25,7 +25,7 @@ After finishing the preparation work, we will build a documentation site for the
 
 The overall layout of the site consists of three parts: the navigation bar, the sidebar and the body part, which also includes the TOC (Table of contents found at the beginning of a book or document).
 
-The Rspress uses [File System Routing](https://rspress.dev/guide/basic/conventional-route.html), on which the module documentation is based, to automate the generation of the sidebar.
+The Rspress uses [File System Routing](https://rspress.rs/guide/basic/conventional-route.html), on which the module documentation is based, to automate the generation of the sidebar.
 For example, if you have the following file structure:
 
 ```bash
@@ -56,7 +56,7 @@ The sidebars corresponding in turn to the above file paths and routing paths are
 ### Configure sidebar
 
 As shown in the figure above, the module documentation has automatically generated sidebars for file system routing, where the text of each column of the sidebar is determined by the file's first level title or directory name.
-If you need to customize the sidebar, please use [\_meta.json](https://rspress.dev/guide/basic/auto-nav-sidebar.html) or configure [sidebar](https://rspress.dev/api/config/config-theme.html#sidebar) directly.
+If you need to customize the sidebar, please use [\_meta.json](https://rspress.rs/guide/basic/auto-nav-sidebar.html) or configure [sidebar](https://rspress.rs/api/config/config-theme.html#sidebar) directly.
 
 :::info
 If your document directory structure complies with internationalization, for example:
@@ -71,7 +71,7 @@ docs
     ├── index.mdx
 ```
 
-You need to follow [internationalization](https://rspress.dev/guide/default-theme/i18n.html) guide and configure `lang` 和 `locales`,
+You need to follow [internationalization](https://rspress.rs/guide/default-theme/i18n.html) guide and configure `lang` 和 `locales`,
 otherwise, the automatically generated sidebar of the module will not handle the `zh` and `en` directories.
 :::
 
@@ -79,8 +79,8 @@ otherwise, the automatically generated sidebar of the module will not handle the
 
 Next, we can focus on writing the content of the document. In addition to the basic Markdown syntax, you may also need to understand the following advanced topics:
 
-- [Using MDX](https://rspress.dev/guide/basic/use-mdx.html)
-- [Using Assets](https://rspress.dev/guide/basic/static-assets.html)
+- [Using MDX](https://rspress.rs/guide/basic/use-mdx.html)
+- [Using Assets](https://rspress.rs/guide/basic/static-assets.html)
 
 ## Component preview
 
@@ -357,7 +357,7 @@ API parse tool.
 
 ### doc
 
-[Config](https://rspress.dev/api/index.html).
+[Config](https://rspress.rs/api/index.html).
 
 ### entries
 
@@ -431,14 +431,14 @@ In case of `internal`, the component will be rendered directly in the page, othe
 ### deprecated: languages
 
 :::warning
-Starting from version MAJOR_VERSION.44.0, please refer to the [Internationalization](https://rspress.dev/guide/default-theme/i18n.html) section to implement multiple languages.
+Starting from version MAJOR_VERSION.44.0, please refer to the [Internationalization](https://rspress.rs/guide/default-theme/i18n.html) section to implement multiple languages.
 :::
 
 ### deprecated: useModuleSidebar
 
 :::warning
-Starting from version MAJOR_VERSION.44.0, a sniffing mechanism has been implemented internally, so please directly use [\_meta.json](https://rspress.dev/guide/basic/auto-nav-sidebar.html)
-or directly configure [sidebar](https://rspress.dev/api/config/config-theme.html#sidebar) to implement a custom sidebar.
+Starting from version MAJOR_VERSION.44.0, a sniffing mechanism has been implemented internally, so please directly use [\_meta.json](https://rspress.rs/guide/basic/auto-nav-sidebar.html)
+or directly configure [sidebar](https://rspress.rs/api/config/config-theme.html#sidebar) to implement a custom sidebar.
 :::
 
 ## Scripts
@@ -448,7 +448,7 @@ or directly configure [sidebar](https://rspress.dev/api/config/config-theme.html
 
 ## Advanced guide
 
-The above has covered the basics of developing module documentation, but this is not enough for developing a complete documentation station. Check out the [Rspress](https://rspress.dev) for an in-depth look at our documentation framework.
+The above has covered the basics of developing module documentation, but this is not enough for developing a complete documentation station. Check out the [Rspress](https://rspress.rs) for an in-depth look at our documentation framework.
 You can modify the documentation framework configuration via the `doc` configuration.
 
 ```ts title="modern.config.ts"

package/docs/en/guide/basic/using-storybook.mdx

@@ -131,7 +131,7 @@ export default config;
 - **Type**: `BuilderConfig`
 - **Default**: `undefined`
 
-The Storybook build capability of Modern.js is provided by [Rsbuild](https://rsbuild.dev/), and the Rsbuild configuration can be modified through builderConfig.
+The Storybook build capability of Modern.js is provided by [Rsbuild](https://rsbuild.rs/), and the Rsbuild configuration can be modified through builderConfig.
 
 ```javascript filename='.storybook/main.js'
 const config = {

package/docs/en/guide/faq/storybook.mdx

@@ -27,11 +27,11 @@ ERR! Error: Cannot find module 'react-dom/package.json'
 
 You can install the react-dom dependency in the project.
 
-``` json
+```json
 {
-    "devDependencies": {
-        "react-dom": "^17"
-    }
+  "devDependencies": {
+    "react-dom": "^17"
+  }
 }
 ```
 
@@ -43,18 +43,19 @@ Solutions:
 2. Find this code: `var _await$Promise$all = await Promise.all([preview, manager,`.
 3. Modify it：
 
-``` js
+```js
 var _await$Promise$all = await Promise.all([
     preview.catch(e => console.info(e)),
     manager // TODO #13083 Restore this when compiling the preview is fast enough
-  // .then((result) => {
-  //   if (!options.ci && !options.smokeTest) openInBrowser(address);
-  //   return result;
-  // })
-  .catch(previewBuilder.bail)]),
-      _await$Promise$all2 = _slicedToArray(_await$Promise$all, 2),
-      previewResult = _await$Promise$all2[0],
-      managerResult = _await$Promise$all2[1]; // TODO #13083 Remove this when compiling the preview is fast enough
+      // .then((result) => {
+      //   if (!options.ci && !options.smokeTest) openInBrowser(address);
+      //   return result;
+      // })
+      .catch(previewBuilder.bail),
+  ]),
+  _await$Promise$all2 = _slicedToArray(_await$Promise$all, 2),
+  previewResult = _await$Promise$all2[0],
+  managerResult = _await$Promise$all2[1]; // TODO #13083 Remove this when compiling the preview is fast enough
 ```
 
 ## Can`t find any stories is your Storybook
@@ -69,36 +70,39 @@ Storybook does not provide a solution for this, but there is one in the Storyboo
 
 1. Add the `.storybook/middleware.js` file and initialize the following:
 
-``` js
+```js
 /* eslint-disable filenames/match-exported */
 module.exports = function expressMiddleware(router) {
-    // router is express router
-    // import { Router } from 'express'
-    // router = new Router();
+  // router is express router
+  // import { Router } from 'express'
+  // router = new Router();
 };
 ```
 
 2. add `http-proxy-middleware` dependency
 3. Add proxy routing-related configuration
 
-``` js
+```js
 /* eslint-disable filenames/match-exported */
-const { createProxyMiddleware } = require("http-proxy-middleware");
+const { createProxyMiddleware } = require('http-proxy-middleware');
 
-module.exports = function expressMiddleware (router) {
-  router.use('/api', createProxyMiddleware({
-    target: "http://localhost:8000",
-    changeOrigin: true
-  }))
-}
+module.exports = function expressMiddleware(router) {
+  router.use(
+    '/api',
+    createProxyMiddleware({
+      target: 'http://localhost:8000',
+      changeOrigin: true,
+    }),
+  );
+};
 ```
 
 Link：https://github.com/storybookjs/storybook/issues/11551
 
 ## Tailwind CSS doesn't work in Storybook
 
-The Storybook build capability of the Modern.js Module is provided by [Rsbuild](https://rsbuild.dev/). Since the underlying implementation of Rsbuild is not integrated with Modern.js Module, the Modern.js Module plugins do not work in Storybook (Rsbuild).
+The Storybook build capability of the Modern.js Module is provided by [Rsbuild](https://rsbuild.rs/). Since the underlying implementation of Rsbuild is not integrated with Modern.js Module, the Modern.js Module plugins do not work in Storybook (Rsbuild).
 
 Solution: Register the tailwindcss PostCSS plugin in storybook.
 
-Reference link: [Rsbuild - tailwindcss](https://rsbuild.dev/guide/basic/tailwindcss#configuring-postcss).
+Reference link: [Rsbuild - tailwindcss](https://rsbuild.rs/guide/basic/tailwindcss#configuring-postcss).

package/docs/en/guide/intro/getting-started.mdx

@@ -8,7 +8,7 @@ sidebar_position: 3
 
 We no longer recommend creating new Modern.js Module projects, as we have developed Rslib based on Rsbuild, which is the next-generation Library development tool that will provide better build performance and plugin ecosystem. You can refer to the [Rslib repository](https://github.com/web-infra-dev/rslib) for more information.
 
-Modern.js will focus on building a first-class full-stack React framework, and Modern.js Module will be gradually deprecated. We have provided a [migration guide](https://lib.rsbuild.dev/guide/migration/modernjs-module) for Modern.js Module projects, which you can follow to migrate your Modern.js Module project to Rslib.
+Modern.js will focus on building a first-class full-stack React framework, and Modern.js Module will be gradually deprecated. We have provided a [migration guide](https://rslib.rs/guide/migration/modernjs-module) for Modern.js Module projects, which you can follow to migrate your Modern.js Module project to Rslib.
 
 The npm packages and documentation for Modern.js Module will remain available. We will no longer add new features to Modern.js Module but will provide necessary bug fixes.
 

package/docs/zh/guide/basic/command-preview.md

@@ -24,7 +24,7 @@ Options:
   -h, --help             展示当前命令的信息
 ```
 
-Modern.js Module 支持 `platform` 构建模式，可以用于执行其他工具的构建任务，目前官方支持的有 [Rspress](https://rspress.dev/)。例如，可以通过执行 `modern build --platform` 命令启动 doc 构建任务生成 doc 产物。
+Modern.js Module 支持 `platform` 构建模式，可以用于执行其他工具的构建任务，目前官方支持的有 [Rspress](https://rspress.rs/)。例如，可以通过执行 `modern build --platform` 命令启动 doc 构建任务生成 doc 产物。
 
 ## `modern new`
 
@@ -66,7 +66,7 @@ Commands:
 
 Modern.js Module 提供了使用调试工具的能力，可以通过 `modern dev` 命令来启动。不过要注意的是，默认情况下是没有提供调试相关的插件，因此此时执行 `modern dev` 会提示： _"No dev tools found available"_。
 
-目前官方支持的调试工具有 [Rspress](https://rspress.dev/)，因此在你执行 `modern new` 命令开启它后，就可以执行 `modern dev` 或者 `modern dev doc` 执行它。
+目前官方支持的调试工具有 [Rspress](https://rspress.rs/)，因此在你执行 `modern new` 命令开启它后，就可以执行 `modern dev` 或者 `modern dev doc` 执行它。
 
 ## `modern change`
 

package/docs/zh/guide/basic/use-module-doc.mdx

@@ -17,7 +17,7 @@ sidebar_position: 5
 ### 前置准备
 
 1. 通过[微生成器](/guide/basic/use-micro-generator)开启文档功能。
-2. 阅读[Rspress 介绍](https://rspress.dev/zh/guide/start/introduction.html)。
+2. 阅读[Rspress 介绍](https://rspress.rs/zh/guide/start/introduction.html)。
 
 完成准备工作之后，接下来我们会基于 Rspress 为模块项目搭建一个文档站点。
 
@@ -25,7 +25,7 @@ sidebar_position: 5
 
 站点整体布局由三部分组成：导航栏、侧边栏以及正文部分，其中正文还包括了 TOC(Table of contents found at the beginning of a book or document)。
 
-Rspress 使用的是[文件系统路由](https://rspress.dev/zh/guide/basic/conventional-route.html)，模块文档基于此实现了侧边栏的自动生成。
+Rspress 使用的是[文件系统路由](https://rspress.rs/zh/guide/basic/conventional-route.html)，模块文档基于此实现了侧边栏的自动生成。
 例如，如果你有以下的文件结构：
 
 ```bash
@@ -55,7 +55,7 @@ docs
 ### 配置侧边栏
 
 如上图所示，模块文档已经为文件系统路由自动生成了侧边栏，其中侧边栏每一栏的文本是由文件的一级标题或者目录名决定。
-如果你需要自定义侧边栏，请使用 [\_meta.json](https://rspress.dev/zh/guide/basic/auto-nav-sidebar.html) 或者直接配置 [sidebar](https://rspress.dev/zh/api/config/config-theme.html#sidebar)。
+如果你需要自定义侧边栏，请使用 [\_meta.json](https://rspress.rs/zh/guide/basic/auto-nav-sidebar.html) 或者直接配置 [sidebar](https://rspress.rs/zh/api/config/config-theme.html#sidebar)。
 
 :::info
 如果你的文档目录结构是符合国际化的，例如：
@@ -70,15 +70,15 @@ docs
     ├── index.mdx
 ```
 
-你需要按照[国际化](https://rspress.dev/zh/guide/default-theme/i18n.html)章节，同时配置 `lang` 和 `locales`，否则模块自动生成的侧边栏不会处理 `zh` 和 `en` 这两个目录。
+你需要按照[国际化](https://rspress.rs/zh/guide/default-theme/i18n.html)章节，同时配置 `lang` 和 `locales`，否则模块自动生成的侧边栏不会处理 `zh` 和 `en` 这两个目录。
 :::
 
 ## 编写文档
 
 接下来我们可以专注于文档内容的编写了。除了最基本的编写 markdown 以外，你可能还需要了解以下进阶内容：
 
-- [使用 MDX](https://rspress.dev/zh/guide/basic/use-mdx.html)
-- [使用静态资源](https://rspress.dev/zh/guide/basic/static-assets.html)
+- [使用 MDX](https://rspress.rs/zh/guide/basic/use-mdx.html)
+- [使用静态资源](https://rspress.rs/zh/guide/basic/static-assets.html)
 
 ## 组件预览
 
@@ -351,7 +351,7 @@ API 解析工具
 
 ### doc
 
-[文档框架配置](https://rspress.dev/zh/api/index.html)
+[文档框架配置](https://rspress.rs/zh/api/index.html)
 
 ### entries
 
@@ -429,14 +429,14 @@ type ParseToolOptions = {
 ### deprecated: languages
 
 :::warning
-从 MAJOR_VERSION.44.0 版本开始，请参考 [国际化](https://rspress.dev/zh/guide/default-theme/i18n.html) 章节来实现多语言。
+从 MAJOR_VERSION.44.0 版本开始，请参考 [国际化](https://rspress.rs/zh/guide/default-theme/i18n.html) 章节来实现多语言。
 :::
 
 ### deprecated: useModuleSidebar
 
 :::warning
-从 MAJOR_VERSION.44.0 版本开始，内部实现了嗅探机制，请直接使用 [\_meta.json](https://rspress.dev/zh/guide/basic/auto-nav-sidebar.html)
-或者直接配置 [sidebar](https://rspress.dev/zh/api/config/config-theme.html#sidebar) 来实现自定义侧边栏。
+从 MAJOR_VERSION.44.0 版本开始，内部实现了嗅探机制，请直接使用 [\_meta.json](https://rspress.rs/zh/guide/basic/auto-nav-sidebar.html)
+或者直接配置 [sidebar](https://rspress.rs/zh/api/config/config-theme.html#sidebar) 来实现自定义侧边栏。
 :::
 
 ## 命令行
@@ -446,7 +446,7 @@ type ParseToolOptions = {
 
 ## 进阶指南
 
-以上已经介绍完了开发模块文档的基本内容，但是这对于开发一个完整的文档站是不够的。查看[Rspress](https://rspress.dev)以深入了解我们的文档框架。
+以上已经介绍完了开发模块文档的基本内容，但是这对于开发一个完整的文档站是不够的。查看[Rspress](https://rspress.rs)以深入了解我们的文档框架。
 你可以通过 `doc` 配置来修改文档框架配置。
 
 ```ts title="modern.config.ts"

package/docs/zh/guide/basic/using-storybook.mdx

@@ -130,7 +130,7 @@ export default config;
 - **类型**: `BuilderConfig`
 - **默认值**: `undefined`
 
-Modern.js 的 Storybook 构建能力由 [Rsbuild](https://rsbuild.dev/) 提供，可通过 builderConfig 修改 Rsbuild 构建配置。
+Modern.js 的 Storybook 构建能力由 [Rsbuild](https://rsbuild.rs/) 提供，可通过 builderConfig 修改 Rsbuild 构建配置。
 
 ```javascript filename='.storybook/main.js'
 const config = {

package/docs/zh/guide/faq/storybook.mdx

@@ -27,11 +27,11 @@ ERR! Error: Cannot find module 'react-dom/package.json'
 
 解决办法：在项目中安装 `react-dom` 依赖。
 
-``` json
+```json
 {
-    "devDependencies": {
-        "react-dom": "^17"
-    }
+  "devDependencies": {
+    "react-dom": "^17"
+  }
 }
 ```
 
@@ -43,18 +43,19 @@ ERR! Error: Cannot find module 'react-dom/package.json'
 2. 找到 `var _await$Promise$all = await Promise.all([preview, manager` 这附近的代码。
 3. 修改成：
 
-``` js
+```js
 var _await$Promise$all = await Promise.all([
     preview.catch(e => console.info(e)),
     manager // TODO #13083 Restore this when compiling the preview is fast enough
-  // .then((result) => {
-  //   if (!options.ci && !options.smokeTest) openInBrowser(address);
-  //   return result;
-  // })
-  .catch(previewBuilder.bail)]),
-      _await$Promise$all2 = _slicedToArray(_await$Promise$all, 2),
-      previewResult = _await$Promise$all2[0],
-      managerResult = _await$Promise$all2[1]; // TODO #13083 Remove this when compiling the preview is fast enough
+      // .then((result) => {
+      //   if (!options.ci && !options.smokeTest) openInBrowser(address);
+      //   return result;
+      // })
+      .catch(previewBuilder.bail),
+  ]),
+  _await$Promise$all2 = _slicedToArray(_await$Promise$all, 2),
+  previewResult = _await$Promise$all2[0],
+  managerResult = _await$Promise$all2[1]; // TODO #13083 Remove this when compiling the preview is fast enough
 ```
 
 ## Couldn't find any stories is your Storybook
@@ -69,36 +70,39 @@ Storybook 没有提供相关方案，不过 Storybook Issue 中有找到相关
 
 1. 添加 `.storybook/middleware.js` 文件，并初始化下面的内容：
 
-``` js
+```js
 /* eslint-disable filenames/match-exported */
 module.exports = function expressMiddleware(router) {
-    // router is express router
-    // import { Router } from 'express'
-    // router = new Router();
+  // router is express router
+  // import { Router } from 'express'
+  // router = new Router();
 };
 ```
 
 2. 添加 http-proxy-middleware 依赖
 3. 添加代理路由相关配置
 
-``` js
+```js
 /* eslint-disable filenames/match-exported */
-const { createProxyMiddleware } = require("http-proxy-middleware");
+const { createProxyMiddleware } = require('http-proxy-middleware');
 
-module.exports = function expressMiddleware (router) {
-  router.use('/api', createProxyMiddleware({
-    target: "http://localhost:8000",
-    changeOrigin: true
-  }))
-}
+module.exports = function expressMiddleware(router) {
+  router.use(
+    '/api',
+    createProxyMiddleware({
+      target: 'http://localhost:8000',
+      changeOrigin: true,
+    }),
+  );
+};
 ```
 
 相关 issue 链接：[#11551](https://github.com/storybookjs/storybook/issues/11551)。
 
 ## Tailwind CSS 在 Storybook 中不生效
 
-Modern.js Module 的 Storybook 构建能力由 [Rsbuild](https://rsbuild.dev/) 提供，由于 Rsbuild 的底层实现与 Modern.js Module 并未打通，因此， Modern.js Module 插件无法在 Storybook (Rsbuild) 中生效。
+Modern.js Module 的 Storybook 构建能力由 [Rsbuild](https://rsbuild.rs/) 提供，由于 Rsbuild 的底层实现与 Modern.js Module 并未打通，因此， Modern.js Module 插件无法在 Storybook (Rsbuild) 中生效。
 
 解决办法：需要在 storybook 中单独注册 tailwindcss 的 PostCSS 插件。
 
-参考链接：[Rsbuild - tailwindcss](https://rsbuild.dev/zh/guide/basic/tailwindcss#%E9%85%8D%E7%BD%AE-postcss)。
+参考链接：[Rsbuild - tailwindcss](https://rsbuild.rs/zh/guide/basic/tailwindcss#%E9%85%8D%E7%BD%AE-postcss)。

package/docs/zh/guide/intro/getting-started.mdx

@@ -8,7 +8,7 @@ sidebar_position: 3
 
 我们不再推荐创建新的 Modern.js Module 项目，因为我们已经基于 Rsbuild 开发了 Rslib，它是下一代的 Library 开发工具，将提供更好的构建性能和插件生态，你可以参考 [Rslib 仓库](https://github.com/web-infra-dev/rslib) 了解更多信息。
 
-Modern.js 后续将专注于构建一流的全栈 React 框架，Modern.js Module 会被逐渐废弃。我们已经为 Modern.js Module 项目提供了 [迁移指南](https://lib.rsbuild.dev/guide/migration/modernjs-module)，你可以参考该指南将 Modern.js Module 项目迁移到 Rslib。
+Modern.js 后续将专注于构建一流的全栈 React 框架，Modern.js Module 会被逐渐废弃。我们已经为 Modern.js Module 项目提供了 [迁移指南](https://rslib.rs/guide/migration/modernjs-module)，你可以参考该指南将 Modern.js Module 项目迁移到 Rslib。
 
 Modern.js Module 的 npm 包和文档将继续保持可用，我们不再向 Modern.js Module 添加新功能，但会提供必要的 bug fixes。
 

package/package.json

@@ -9,7 +9,7 @@
     "directory": "packages/document/module-doc"
   },
   "license": "MIT",
-  "version": "2.67.7",
+  "version": "2.67.8",
   "main": "index.js",
   "devDependencies": {
     "@modern-js/doc-plugin-auto-sidebar": "2.58.1",