@modern-js/module-tools-docs 2.0.1 → 2.0.2

package/docs/zh/guide/basic/modify-output-product.md

@@ -43,7 +43,7 @@ export default defineConfig({
 
 **构建预设的值可以是字符串形式**，因此这样形式的构建预设叫做预设字符串。
 
-模块工程解决方案根据 npm 包使用的通用场景，提供了通用的构建预设字符串以及相应的变体。目前支持的所有预设字符串可以通过 [BuildPreset API](/zh/api/build-config) 查看。这里讲解一下关于**通用的预设字符串与变体之间的关系**。
+模块工程解决方案根据 npm 包使用的通用场景，提供了通用的构建预设字符串以及相应的变体。目前支持的所有预设字符串可以通过 [BuildPreset API](/api/config/build-config) 查看。这里讲解一下关于**通用的预设字符串与变体之间的关系**。
 
 在通用的预设字符串中，`"npm-library"` 可以用于在开发库类型的 npm 包的场景下使用，它适合大多数普通的模块类型项目。当设置 `"npm-library"` 的时候，项目的输出产物会有以下特点：
 
@@ -75,7 +75,7 @@ export default defineConfig({
 
 在上面的代码实现中，`preset.NPM_LIBRARY` 与预设字符串 `"npm-library"` 是相对应的，它代表着 `"npm-library"` 等价的多组构建相关的配置。我们通过 `map` 方法遍历了 `NPM_LIBRARY` 这个数组，在这个数组中包含了多个 `buildConfig` 对象。我们将原本的 `buildConfig` 对象进行了浅拷贝并修改了浅拷贝后得到 `buildConfig.target`，将它指定为 `es2017`。
 
-> 关于 `preset.NPM_LIBRARY` 具体对应的值，可以通过 [BuildPreset API](/zh/api/build-config) 查看。在 `preset` 对象下不仅包含了 `NPM_LIBRARY`，还包含了其他类似的常量。
+> 关于 `preset.NPM_LIBRARY` 具体对应的值，可以通过 [BuildPreset API](/api/config/build-config) 查看。在 `preset` 对象下不仅包含了 `NPM_LIBRARY`，还包含了其他类似的常量。
 
 那么这里的 `buildConfig` 对象是什么呢？之前提到的构建产物特点又是根据什么呢？
 
@@ -87,45 +87,45 @@ export default defineConfig({
 
 **构建产物的基本属性包括：**
 
-- 产物是否被打包：对应的 API 是 [`buildConfig.buildType`](/zh/api/build-config#buildtype)。
-- 产物对于语法的支持：对应的 API 是 [`buildConfig.target`](/zh/api/build-config#target)。
-- 产物格式：对应的 API 是 [`buildConfig.format`](/zh/api/build-config#format)。
-- 产物类型文件如何处理，对应的 API 是 [`buildConfig.dts`](/zh/api/build-config#dts)。
-- 产物的 sourceMap 如何处理：对应的 API 是 [`buildConfig.sourceMap`](/zh/api/build-config#sourcemap)。
-- 产物对应的输入（或者是源文件）：对应的 API 是 [`buildConfig.input`](/zh/api/build-config#input)。
-- 产物输出的目录：对应的 API 是 [`buildConfig.outDir`](/zh/api/build-config#outDir)。
-- 构建的源码目录：对应的 API 是 [`buildConfig.sourceDir`](/zh/api/build-config#sourcedir)。
+- 产物是否被打包：对应的 API 是 [`buildConfig.buildType`](/api/config/build-config#buildtype)。
+- 产物对于语法的支持：对应的 API 是 [`buildConfig.target`](/api/config/build-config#target)。
+- 产物格式：对应的 API 是 [`buildConfig.format`](/api/config/build-config#format)。
+- 产物类型文件如何处理，对应的 API 是 [`buildConfig.dts`](/api/config/build-config#dts)。
+- 产物的 sourceMap 如何处理：对应的 API 是 [`buildConfig.sourceMap`](/api/config/build-config#sourcemap)。
+- 产物对应的输入（或者是源文件）：对应的 API 是 [`buildConfig.input`](/api/config/build-config#input)。
+- 产物输出的目录：对应的 API 是 [`buildConfig.outDir`](/api/config/build-config#outDir)。
+- 构建的源码目录：对应的 API 是 [`buildConfig.sourceDir`](/api/config/build-config#sourcedir)。
 
 **构建产物所需的常用功能包括：**
 
-- 别名：对应的 API 是 [`buildConfig.alias`](/zh/api/build-config#alias)。
-- 静态资源处理：对应的 API 是 [`buildConfig.asset`](/zh/api/build-config#asset)。
+- 别名：对应的 API 是 [`buildConfig.alias`](/api/config/build-config#alias)。
+- 静态资源处理：对应的 API 是 [`buildConfig.asset`](/api/config/build-config#asset)。
 - 第三方依赖处理：对应的 API 有：
-  - [`buildConfig.autoExternal`](/zh/api/build-config#autoexternal)。
-  - [`buildConfig.externals`](/zh/api/build-config#externals)。
-- 拷贝：对应的 API 是 [`buildConfig.copy`](/zh/api/build-config#copy)。
-- 全局变量替换：对应的 API 是 [`buildConfig.define`](/zh/api/build-config#define)。
-- 指定 [JSX](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) 编译方式，对应的 API 是 [`buildConfig.jsx`](/zh/api/build-config#jsx)。
+  - [`buildConfig.autoExternal`](/api/config/build-config#autoexternal)。
+  - [`buildConfig.externals`](/api/config/build-config#externals)。
+- 拷贝：对应的 API 是 [`buildConfig.copy`](/api/config/build-config#copy)。
+- 全局变量替换：对应的 API 是 [`buildConfig.define`](/api/config/build-config#define)。
+- 指定 [JSX](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) 编译方式，对应的 API 是 [`buildConfig.jsx`](/api/config/build-config#jsx)。
 
 **一些高级属性或者使用频率不高的功能：**
 
-- 产物代码压缩：对应的 API 是 [`buildConfig.minify`](/zh/api/build-config#minify)。
-- 代码分割：[`buildConfig.spitting`](/zh/api/build-config#splitting)
-- 指定构建产物用于 NodeJS 环境还是浏览器环境：对应的 API 是 [`buildConfig.platform`](/zh/api/build-config#platform)。
+- 产物代码压缩：对应的 API 是 [`buildConfig.minify`](/api/config/build-config#minify)。
+- 代码分割：[`buildConfig.spitting`](/api/config/build-config#splitting)
+- 指定构建产物用于 NodeJS 环境还是浏览器环境：对应的 API 是 [`buildConfig.platform`](/api/config/build-config#platform)。
 - umd 产物相关：
-  - 指定 umd 产物外部导入的全局变量：对应的 API 是 [`buildConfig.umdGlobals`](/zh/api/build-config#umdglobals)。
-  - 指定 umd 产物的模块名：对应的 API 是 [`buildConfig.umdModuleName`](/zh/api/build-config#umdmodulename)。
+  - 指定 umd 产物外部导入的全局变量：对应的 API 是 [`buildConfig.umdGlobals`](/api/config/build-config#umdglobals)。
+  - 指定 umd 产物的模块名：对应的 API 是 [`buildConfig.umdModuleName`](/api/config/build-config#umdmodulename)。
 
 除了以上分类以外，关于这些 API 的常见问题和最佳实践可以通过下面的链接来了解，敬请期待。
 
-- [什么是 `bundle` 和 `bundleless`?](/zh/guide/advance/in-depth-about-build#bundle-和-bundleless)
-- [`input` 与 `sourceDir` 的关系](/zh/guide/advance/in-depth-about-build#input-与-sourcedir-的关系)。
-- [产物中类型文件的多种生成方式](/zh/guide/advance/in-depth-about-build#类型文件)。
-- [`buildConfig.define` 不同场景的使用方式。](/zh/guide/advance/in-depth-about-build#buildconfigdefine-不同场景的使用方式)
-- [如何处理第三方依赖？](/zh/guide/advance/external-dependency)
-- [如何使用拷贝？](/zh/guide/advance/copy)
-- [如何构建 umd 产物？](/zh/guide/advance/build-umd#设置项目的全局变量名称)
-- [静态资源目前所支持的能力。](/zh/guide/advance/asset)
+- [什么是 `bundle` 和 `bundleless`?](/guide/advance/in-depth-about-build#bundle-和-bundleless)
+- [`input` 与 `sourceDir` 的关系](/guide/advance/in-depth-about-build#input-与-sourcedir-的关系)。
+- [产物中类型文件的多种生成方式](/guide/advance/in-depth-about-build#类型文件)。
+- [`buildConfig.define` 不同场景的使用方式。](/guide/advance/in-depth-about-build#buildconfigdefine-不同场景的使用方式)
+- [如何处理第三方依赖？](/guide/advance/external-dependency)
+- [如何使用拷贝？](/guide/advance/copy)
+- [如何构建 umd 产物？](/guide/advance/build-umd#设置项目的全局变量名称)
+- [静态资源目前所支持的能力。](/guide/advance/asset)
 
 ## 什么时候使用 `buildConfig`
 

package/docs/zh/guide/basic/publish-your-project.md

@@ -20,7 +20,7 @@ sidebar_position: 7
 
 当这些变化一旦完成后，需要通过以下命令来对当前的变化进行记录：
 
-- [`modern change`](/zh/guide/command-preview#modern-change)
+- [`modern change`](/guide/basic/command-preview#modern-change)
 
 执行 `modern change` 命令后会向开发者提出几个问题，并根据开发者的回答生成变更记录。变更记录文件包含了版本变化的类型和其描述，该文件会被提交到 git 仓库中。
 
@@ -53,7 +53,7 @@ publish test
 
 当需要更新项目版本的时候，执行以下命令：
 
-- [`modern bump`](/zh/guide/command-preview#modern-bump)
+- [`modern bump`](/guide/basic/command-preview#modern-bump)
 
 执行 `modern bump` 将会基于 `.changeset/` 目录下记录了变更的 Markdown 文件内容来修改 `package.json` 中的版本号，同时生成 `CHANGELOG.md` 文件。**而当版本更新完成后，这些记录变更的 Markdown 文件也会被删除，也可说这些 Markdown 文件被“消耗”掉了**。
 
@@ -71,7 +71,7 @@ publish test
 
 发布项目可以执行以下命令：
 
-- [`modern publish`](/zh/guide/command-preview#modern-release)
+- [`modern publish`](/guide/basic/command-preview#modern-release)
 
 `modern release` 命令可以将项目发布到 npm Registry。
 
@@ -89,7 +89,7 @@ modern release --tag beta
 
 当需要在正式发布之前进行预发布，则需要执行以下命令：
 
-- [`modern pre`](/zh/guide/command-preview#modern-pre)
+- [`modern pre`](/guide/basic/command-preview#modern-pre)
 
 首先 `modern pre enter <tag>` 进入预发布模式，`<tag>` 可以与发布项目的时候使用 `modern release --tag` 命令指定的 `tag` 一致。
 

package/docs/zh/guide/basic/test-your-project.mdx

@@ -38,7 +38,7 @@ modern test --updateSnapshot
 /obj/eden-cn/uhbfnupenuhf/test-result.png
 模块工程方案对测试提供了以下配置：
 
-- [`testing`](/zh/api/config-test)
+- [`testing`](/api/config/testing)
 
 可以在 `modern.config.(j|t)s` 中增加它。
 
@@ -100,10 +100,12 @@ npm run test
 
 ### 组件
 
-对于组件，Modern.js 的 [Runtime API](xxx) 提供了用于测试 UI 组件的功能，其功能由 `@modern-js/runtime/testing` 提供。
+{/* 链接待补充 */}
+
+对于组件，Modern.js 的 Runtime API 提供了用于测试 UI 组件的功能，其功能由 `@modern-js/runtime/testing` 提供。
 
 :::tip
-如果需要使用 Runtime API，那么可以通过 [微生成器](/zh/guide/command-preview) 开启。
+如果需要使用 Runtime API，那么可以通过 [微生成器](/guide/basic/command-preview) 开启。
 :::
 
 <CH.Spotlight>

package/docs/zh/guide/basic/use-micro-generator.md

@@ -12,7 +12,7 @@ sidebar_position: 4
 
 因此通过这些能力，**微生成器可以为项目开启额外的特性功能**。
 
-可以通过 [`modern new`](/zh/guide/command-preview) 启动微生成器。目前模块工程方案支持的微生成器功能有：
+可以通过 [`modern new`](/guide/basic/command-preview) 启动微生成器。目前模块工程方案支持的微生成器功能有：
 
 ## Storybook 调试
 
@@ -20,8 +20,8 @@ sidebar_position: 4
 
 关于如何启动 Storybook 以及如何使用 Storybook，可以查看下面的链接：
 
-- [`modern dev`](/zh/guide/command-preview#modern-dev)
-- [使用 Storybook](/zh/guide/using-storybook)
+- [`modern dev`](/guide/basic/command-preview#modern-dev)
+- [使用 Storybook](/guide/basic/using-storybook)
 
 ## Tailwind CSS 支持
 
@@ -29,10 +29,10 @@ sidebar_position: 4
 
 关于如何在模块工程里使用 Tailwind CSS，可以查看：
 
-- [使用 Tailwind CSS](xxx)
+- [使用 Tailwind CSS](https://modernjs.dev/docs/apis/module/config/tools/tailwindcss)
 
 ## 启动 Modern.js Runtime API
 
-**Modern.js 提供了 [Runtime API](xxx) 能力，这些 API 只能在 Modern.js 的应用项目环境中使用**。如果你需要开发一个 Modern.js 应用环境中使用的组件，那么你可以开启该特性，微生成器会增加 `"@modern-js/runtime"`依赖。
+**Modern.js 提供了 [Runtime API](https://modernjs.dev/docs/apis/module/runtime/) 能力，这些 API 只能在 Modern.js 的应用项目环境中使用**。如果你需要开发一个 Modern.js 应用环境中使用的组件，那么你可以开启该特性，微生成器会增加 `"@modern-js/runtime"`依赖。
 
 另外，Storybook 调试工具也会通过检测项目的依赖确定项目是否需要使用 Runtime API，并且提供与 Modern.js 应用项目一样的 Runtime API 运行环境。

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

@@ -6,8 +6,8 @@ sidebar_position: 5
 
 首先如果没有看过以下内容的话，可以先花几分钟先了解一下：
 
-- [使用微生成器开启 Storybook 调试](/zh/guide/use-micro-generator#storybook-调试)
-- [`modern dev`](/zh/guide/command-preview#modern-dev)
+- [使用微生成器开启 Storybook 调试](/guide/basic/use-micro-generator#storybook-调试)
+- [`modern dev`](/guide/basic/command-preview#modern-dev)
 
 [Storybook](https://storybook.js.org/) 是一个专门用于组件调试的工具，围绕着组件开发提供了：
 
@@ -172,7 +172,9 @@ Storybook 官方通过一个名为 `.storybook` 的文件夹来进行项目配
 
 目前可以通过该配置对 Storybook 的 webpack 配置进行修改。
 
-- [`dev.storybook.webpack`](xxx)
+{/* 链接待补充 */}
+
+- `dev.storybook.webpack`
 
 ### 构建 Storybook 产物
 
@@ -184,6 +186,6 @@ modern build --platform storybook
 
 关于 `modern build --platform` 命令可以查看：
 
-- [`modern build`](/zh/guide/command-preview#modern-build)
+- [`modern build`](/guide/basic/command-preview#modern-build)
 
 构建完成后，可以在 `dist/storybook-static` 目录看到构建产物文件。

package/docs/zh/guide/best-practices/components.mdx

@@ -609,7 +609,7 @@ Tailwind CSS 提供了 [`@apply`](https://v2.tailwindcss.com/docs/functions-and-
 
 对于以下代码，在 bundle 和 bundleless 两种模式下，构建产物会有很大区别。
 
-> 所谓 bundle 和 bundleless 可以查看 [【Bundle 和 Bundleless】](/zh/guide/advance/in-depth-about-build#bundle-和-bundleless)
+> 所谓 bundle 和 bundleless 可以查看 [【Bundle 和 Bundleless】](/guide/advance/in-depth-about-build#bundle-和-bundleless)
 
 ```tsx ./src/index.tsx
 import 'tailwindcss/utilities.css';
@@ -623,7 +623,7 @@ Bundle 模式下，会将第三方依赖打包进来。
 
 对于样式则会生成一份单独的产物文件，并且在 Js 产物文件中并不会存在导入样式的相关代码。
 
-如果需要将样式注入 Js 产物中，可以开启 [`style.inject` API](/zh/api/build-config#inject)。
+如果需要将样式注入 Js 产物中，可以开启 [`style.inject` API](/api/config/build-config#inject)。
 
 <CH.Code>
 ```css ./dist/es/index.css
@@ -732,8 +732,8 @@ export { src_default as default };
 
 如果需要对 CSS Modules 进行配置，可以查看一下 API：
 
-- [autoModules](zh/api/build-config#automodules)
-- [modules](/zh/api/build-config#modules)
+- [autoModules](/api/config/build-config#automodules)
+- [modules](/api/config/build-config#modules)
 
 下面是一个代码示例：
 
@@ -771,7 +771,7 @@ export default () => {
 - `./dist/lib`: 包含了支持 es6 语法的 CommonJS 格式的 bundleless 产物。
 - `./dist/types`: 包含了类型文件。
 
-如果对使用语法支持有要求，可以手动配置 [`buildPreset`](/zh/api/build-preset)，并且支持在 `npm-component` 基础上增加后缀的方式修改支持的语法：
+如果对使用语法支持有要求，可以手动配置 [`buildPreset`](/api/config/build-preset)，并且支持在 `npm-component` 基础上增加后缀的方式修改支持的语法：
 
 ```tsx
 export default defineConfig({
@@ -779,15 +779,15 @@ export default defineConfig({
 });
 ```
 
-如果对构建产物目录结构有特殊需求，则可以使用 [`buildConfig` API](/zh/api/build-config)，可以通过以下文档来了解使用方式：
+如果对构建产物目录结构有特殊需求，则可以使用 [`buildConfig` API](/api/config/build-config)，可以通过以下文档来了解使用方式：
 
-- [修改输出产物](/zh/guide/basic/modify-output-product#构建配置对象)
-- [深入理解构建](/zh/guide/advance/in-depth-about-build)
+- [修改输出产物](/guide/basic/modify-output-product#构建配置对象)
+- [深入理解构建](/guide/advance/in-depth-about-build)
 
 ## 测试组件
 
-关于如何对组件进行测试，可以参考 [【测试项目】](/zh/guide/basic/test-your-project)。
+关于如何对组件进行测试，可以参考 [【测试项目】](/guide/basic/test-your-project)。
 
 ## 发布组件
 
-推荐使用模块工程提供版本发布功能，可以参考 [【版本管理与发布】](/zh/guide/basic/publish-your-project)。
+推荐使用模块工程提供版本发布功能，可以参考 [【版本管理与发布】](/guide/basic/publish-your-project)。

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

@@ -79,6 +79,6 @@ npx @modern-js/create your-project-dir-name
 
 选择适合你的教程：
 
-- 我是初学者，需要学习 Module Tools 的[基础使用](/zh/guide/before-getting-started)。
-- 我已经初步掌握了 Module Tools 的使用，可以学习 Module Tools 的[高级使用](/zh/guide/before-getting-started)。
+- 我是初学者，需要学习 Module Tools 的[基础使用](/guide/basic/before-getting-started)。
+- 我已经初步掌握了 Module Tools 的使用，可以学习 Module Tools 的[高级使用](/guide/basic/before-getting-started)。
 - 我是项目的维护者，需要学习如何开发 Module Tools 的插件以及了解更多关于 Module Tools 进阶的内容。

package/docs/zh/index.md

@@ -2,7 +2,7 @@
 pageType: home
 
 hero:
-  name: Modern.js tools
+  name: Module Tools
   text: 模块工程解决方案
   tagline: 简单、强大、高性能的现代化npm包开发方案
   actions:

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

@@ -51,7 +51,7 @@ export const ExamplePlugin = (): CliPlugin<ModuleTools> => {
 
 ---
 
-然后我们通过 [`plugins`](/zh/api/plugins) API，将刚刚写好的插件进行注册。
+然后我们通过 [`plugins`](/api/config/plugins) API，将刚刚写好的插件进行注册。
 
 ```ts ./modern.config.ts
 import { ExamplePlugin } from './plugins/example';
@@ -80,5 +80,5 @@ build over
 
 除了以上内容以外，我们还需要了解：
 
-- [插件对象、类型定义与推荐配置项](/zh/plugins/guide/plugin-object)
-- [setup 函数、`api` 对象参数、生命周期钩子](/zh/plugins/guide/setup-function)
+- [插件对象、类型定义与推荐配置项](/plugins/guide/plugin-object)
+- [setup 函数、`api` 对象参数、生命周期钩子](/plugins/guide/setup-function)

package/docs/zh/plugins/guide/setup-function.mdx

@@ -4,7 +4,7 @@ sidebar_position: 3
 
 # Setup 函数
 
-在[【插件对象】](/zh/plugins/guide/plugin-object) 部分我们知道插件对象包含了一个 `setup` 函数，该函数不仅包含了一个 `api` 对象参数，同时还可以返回一个 Hooks 对象。
+在[【插件对象】](/plugins/guide/plugin-object) 部分我们知道插件对象包含了一个 `setup` 函数，该函数不仅包含了一个 `api` 对象参数，同时还可以返回一个 Hooks 对象。
 
 ## 插件 API 对象
 
@@ -114,4 +114,4 @@ export default (): CliPlugin<ModuleTools> => ({
 - `buildPlatform` 钩子：仅在执行 `build --platform` 命令生成其他构建产物时触发。
 - 调试钩子：运行 `dev` 命令时会触发的钩子。
 
-关于生命周期钩子的完整列表参考 [API 文档](/zh/api/plugin-hooks)。
+关于生命周期钩子的完整列表参考 [API 文档](/api/plugin-api/plugin-hooks)。

package/modern.config.ts

@@ -57,7 +57,7 @@ export default defineConfig({
     root: path.join(__dirname, 'docs'),
     lang: 'zh',
     base: isDevCommand ? '' : '/module-tools/',
-    title: 'Module tools',
+    title: 'Module Tools',
     // The plugins for doc tools.
     plugins: [
       pluginAutoSidebar({
@@ -71,6 +71,7 @@ export default defineConfig({
       }),
     ],
     markdown: {
+      checkDeadLinks: true,
       remarkPlugins: [
         [
           remarkCodeHike,
@@ -99,7 +100,7 @@ export default defineConfig({
           lang: 'zh',
           label: '简体中文',
           nav: getNavbar('zh'),
-          title: 'Module tools',
+          title: 'Module Tools',
           outlineTitle: '目录',
           prevPageText: '上一页',
           nextPageText: '下一页',
@@ -109,7 +110,7 @@ export default defineConfig({
           lang: 'en',
           label: 'English',
           nav: getNavbar('en'),
-          title: 'Module tools',
+          title: 'Module Tools',
           description: 'Module Engineering Solutions',
         },
       ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modern-js/module-tools-docs",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "docs",
   "main": "index.js",
   "keywords": [],
@@ -11,8 +11,8 @@
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "shiki": "^0.11.1",
-    "@modern-js/doc-plugin-auto-sidebar": "2.0.1",
-    "@modern-js/doc-tools": "2.0.1"
+    "@modern-js/doc-plugin-auto-sidebar": "2.0.2",
+    "@modern-js/doc-tools": "2.0.2"
   },
   "scripts": {
     "dev": "modern dev",