@modern-js/main-doc 2.0.3-alpha.0 → 2.1.0

package/en/docusaurus-plugin-content-docs/current/tutorials/first-app/c03-css.md

@@ -52,7 +52,6 @@ Execute `pnpm run dev` to see the expected running result:
 
 Next we do a little refactoring. To enhance legibility and make the code easier to maintain, we can split the Avatar component. We execute the following command at the end point to create a new file:
 
-
 <Tabs>
 <TabItem value="macOS" label="macOS" default>
 
@@ -121,8 +120,8 @@ Execute `pnpm run new` and select the following to start Tailwind CSS:
 Register the Tailwind plugin in `modern.config.ts`:
 
 ```ts title="modern.config.ts"
-import AppToolsPlugin, { defineConfig } from '@modern-js/app-tools';
-import TailwindCSSPlugin from '@modern-js/plugin-tailwindcss';
+import appTools, { defineConfig } from '@modern-js/app-tools';
+import tailwindcssPlugin from '@modern-js/plugin-tailwindcss';
 
 // https://modernjs.dev/docs/apis/app/config
 export default defineConfig({
@@ -133,7 +132,7 @@ export default defineConfig({
   server: {
     ssr: true,
   },
-  plugins: [AppToolsPlugin(), TailwindCSSPlugin()],
+  plugins: [appTools(), tailwindcssPlugin()],
 });
 ```
 
@@ -175,7 +174,7 @@ import 'tailwindcss/components.css';
 import 'tailwindcss/utilities.css';
 import Item from '../components/Item';
 
-const getAvatar = (users: Array<{ name: string; email: string }>) =>
+const getAvatar = (users: Array<{ name: string, email: string }>) =>
   users.map(user => ({
     ...user,
     avatar: `https://avatars.dicebear.com/v2/identicon/${user.name}.svg`,
@@ -285,7 +284,7 @@ A Utility Class named `custom-text-gray` is implemented in `src/routes/styles/ut
 
 ```css
 :root {
-  --custom-text-color:rgb(113, 128, 150);
+  --custom-text-color: rgb(113, 128, 150);
 }
 
 .custom-text-gray {
@@ -294,7 +293,7 @@ A Utility Class named `custom-text-gray` is implemented in `src/routes/styles/ut
 ```
 
 :::info note
-Modern.js integrates with [PostCSS](/docs/guides/basic-features/css/postcss) and supports modern CSS syntax features such as [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/-- *).
+Modern.js integrates with [PostCSS](/docs/guides/basic-features/css/postcss) and supports modern CSS syntax features such as [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties).
 :::
 
 Use in `src/routes/components/Item/index.tsx`:
@@ -320,4 +319,3 @@ This is just to demonstrate Utility Class usage. In a real project, with Tailwin
 
 However, with the support of PostCSS, modern CSS should be sufficient to meet these development needs, and the performance is also better than that of the preprocessor. It is recommended to use `.css` files first.
 :::
-

package/en/docusaurus-plugin-content-docs/current/tutorials/first-app/c04-routes.md

@@ -140,7 +140,7 @@ Introducing three React Hooks: `useState` and `useNavigate` and `useParams`, as
 ```js
 import { useState } from 'react';
 import { Radio, RadioChangeEvent } from 'antd';
-import { Outlet, useLocation, useNavigate } from "@modern-js/runtime/router";
+import { Outlet, useLocation, useNavigate } from '@modern-js/runtime/router';
 ```
 
 Finally, add local state and related logic to the Layout component:
@@ -166,4 +166,4 @@ At this point, the page navigation bar implementation has been completed, and ex
 
 Click Archives in the navigation bar, you can see that the selected state and URL of the radio box will change, the page is not refreshed, only CSR occurs.
 
-Accessing the two pages through the URL, you can see that the HTML content is different, because the page executes the logic of  client routing in the SSR stage, and the HTML already contains the final render result.
+Accessing the two pages through the URL, you can see that the HTML content is different, because the page executes the logic of client routing in the SSR stage, and the HTML already contains the final render result.

package/en/docusaurus-plugin-content-docs/current/tutorials/first-app/c05-loader.md

@@ -67,7 +67,7 @@ function Index() {
       </Helmet>
       <List
         dataSource={data}
-        renderItem={(info) => <Item key={info.name} info={info} />}
+        renderItem={info => <Item key={info.name} info={info} />}
       />
     </div>
   );
@@ -77,6 +77,7 @@ export default Index;
 ```
 
 <!-- Todo 重新截图，SSR 内容 -->
+
 Re-execute `pnpm run dev`, view `view-source: http://localhost:8080/`, or view the "Preview" of the HTML request in the Network panel of devtools, you can see that the HTML rendered by SSR already contains the complete UI:
 
 ![display6](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/11/display6.png)

package/en/docusaurus-plugin-content-docs/current/tutorials/first-app/c07-container.md

@@ -179,10 +179,10 @@ ni src/containers/Contacts.tsx
 We extracted the common part of the original two `page.tsx`, and the code of `src/containers/Contacts.tsx` is as follows:
 
 ```tsx
-import { Helmet } from "@modern-js/runtime/head";
-import { useModel } from "@modern-js/runtime/model";
-import { List } from "antd";
-import Item from "../components/Item";
+import { Helmet } from '@modern-js/runtime/head';
+import { useModel } from '@modern-js/runtime/model';
+import { List } from 'antd';
+import Item from '../components/Item';
 import { Helmet } from '@modern-js/runtime/head';
 import { useModel } from '@modern-js/runtime/model';
 import { List } from 'antd';
@@ -246,7 +246,7 @@ export default Index;
 
 The refactoring is complete, and the current project structure is:
 
-```md
+```bash
 .
 ├── README.md
 ├── dist

package/en/docusaurus-plugin-content-docs/current/tutorials/first-app/c08-entries.md

@@ -20,7 +20,7 @@ We can also use it to create new project elements and execute `pnpm run new` in
 
 When created, the project will look like this:
 
-```md
+```bash
 .
 ├── README.md
 ├── modern.config.ts
@@ -52,7 +52,6 @@ When created, the project will look like this:
 │       └── styles
 │           └── utils.css
 └── tsconfig.json
-
 ```
 
 You can see that the files of the contact list application are automatically refactored into `src/myapp/`.
@@ -93,9 +92,9 @@ In the Modern.js configuration file, we can write our own code to control the co
 
 Now, modify the `modern.config.ts` to add something:
 
-```typescript
-import AppToolsPlugin, { defineConfig } from '@modern-js/app-tools';
-import TailwindCSSPlugin from '@modern-js/plugin-tailwindcss';
+```ts
+import appTools, { defineConfig } from '@modern-js/app-tools';
+import tailwindcssPlugin from '@modern-js/plugin-tailwindcss';
 
 // https://modernjs.dev/docs/apis/app/config
 export default defineConfig({
@@ -109,7 +108,7 @@ export default defineConfig({
       'landing-page': false,
     },
   },
-  plugins: [AppToolsPlugin(), TailwindCSSPlugin()],
+  plugins: [appTools(), tailwindcssPlugin()],
 });
 ```
 

package/package.json

@@ -11,20 +11,20 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.0.3-alpha.0",
+  "version": "2.1.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "^2.0.2"
+    "@modern-js/builder-doc": "^2.1.0"
   },
   "devDependencies": {
-    "@modern-js/builder-doc": "2.0.2",
     "ts-node": "^10",
     "fs-extra": "^10",
     "@types/node": "^16",
-    "@types/fs-extra": "^9"
+    "@types/fs-extra": "^9",
+    "@modern-js/builder-doc": "2.1.0"
   },
   "scripts": {
     "build": "npx ts-node ./scripts/sync.ts"

package/scripts/config.ts

@@ -16,6 +16,8 @@ export type Language = 'en' | 'zh';
 const createMarkdown = (summary: Summary, lng: Language) => {
   const { name, dirname } = summary;
 
+  const langPrefix = lng === 'zh' ? '' : `/${lng}`;
+
   return `---
 title: ${dirname}.${name}
 sidebar_label: ${name}
@@ -24,10 +26,10 @@ sidebar_label: ${name}
 :::info BUILDER
 ${
   tip[lng]
-} [${dirname}.${name}](https://modernjs.dev/builder/zh/api/config-${dirname}.html#${dirname}-${name.toLowerCase()})。
+} [${dirname}.${name}](https://modernjs.dev/builder${langPrefix}/api/config-${dirname}.html#${dirname}-${name.toLowerCase()})。
 :::
 
-import Main from '@modern-js/builder-doc/${lng}/config/${dirname}/${name}.md'
+import Main from '@modern-js/builder-doc/docs/${lng}/config/${dirname}/${name}.md'
 
 <Main />
 `;

package/scripts/summary.en.json

@@ -1 +1 @@
-[{"name":"assetPrefix","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssExtract","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]
+[{"name":"assetPrefix","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"tags","dirname":"html"},{"name":"tagsByEntries","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssExtract","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]

package/scripts/summary.zh.json

@@ -1 +1 @@
-[{"name":"assetPrefix","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssExtract","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]
+[{"name":"assetPrefix","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"tags","dirname":"html"},{"name":"tagsByEntries","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssExtract","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]

package/scripts/sync.ts

@@ -19,7 +19,7 @@ const summary = (lng: string) => {
   const fl = walk(
     path.join(
       process.cwd(),
-      `./node_modules/@modern-js/builder-doc/${lng}/config`,
+      `./node_modules/@modern-js/builder-doc/docs/${lng}/config`,
     ),
   );
   const json = fl.map(fpath => {

package/zh/apis/app/commands/index.md

@@ -5,8 +5,3 @@ type: ref
 # 命令
 
 本节涵盖了所有命令。
-
-
-
-
-

package/zh/apis/app/commands/lint.md

@@ -15,7 +15,7 @@ Options:
 
 运行 `ESLint` 检查代码语法情况。通常情况下，我们只需要在 `git commit` 阶段通过 `lint-staged` 检查本次提交修改的部分代码。
 
-* `--no-fix` 参数设置后可以关闭自动修复 lint 错误代码的能力。
+- `--no-fix` 参数设置后可以关闭自动修复 lint 错误代码的能力。
 
 import CommandTip from '@site-docs/components/command-tip.md'
 

package/zh/apis/app/commands/serve.md

@@ -21,12 +21,10 @@ Options:
 export default defineConfig({
   server: {
     port: 8081,
-  }
-})
+  },
+});
 ```
 
 import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />
-
-

package/zh/apis/app/hooks/api/framework/lambda.md

@@ -19,23 +19,23 @@ sidebar_position: 1
 
 路由系统会将以 `index` 命名的文件会被映射到上一层目录。
 
-* `api/lambda/index.ts` -> `$BASENAME/`
-* `api/lambda/user/index.ts` -> `$BASENAME/user`
+- `api/lambda/index.ts` -> `$BASENAME/`
+- `api/lambda/user/index.ts` -> `$BASENAME/user`
 
 ### 多级路由
 
 路由系统也支持解析多级的文件，如果创建文件夹结构，文件仍会以相同方式自动解析路由。
 
-* `api/lambda/hello.ts` -> `$BASENAME/hello`
-* `api/lambda/user/list.ts` -> `$BASENAME/user/list`
+- `api/lambda/hello.ts` -> `$BASENAME/hello`
+- `api/lambda/user/list.ts` -> `$BASENAME/user/list`
 
 ### 动态路由
 
 同样的，你可以通过创建带有 `[xxx]` 的文件夹或者文件来支持动态的命名路由参数。
 
-* `api/lambda/user/[username]/info.ts` -> `$BASENAME/user/:username/info`
-* `api/lambda/user/[username]/delete.ts` -> `$BASENAME/user/:username/delete`
-* `api/lambda/article/[id]/info.ts` -> `$BASENAME/article/:id/info`
+- `api/lambda/user/[username]/info.ts` -> `$BASENAME/user/:username/info`
+- `api/lambda/user/[username]/delete.ts` -> `$BASENAME/user/:username/delete`
+- `api/lambda/article/[id]/info.ts` -> `$BASENAME/article/:id/info`
 
 其中的 `$BASENAME` 可以在 `modern.config.js` 中进行配置，默认值为 `/api`。
 
@@ -43,11 +43,11 @@ sidebar_position: 1
 
 默认 `api` 目录下所有文件都会当作 BFF 函数文件去解析，但同样我们也设置了白名单，这些文件不被被解析：
 
-* 命名以 `_` 开头的文件。例如：`_utils.ts`。
-* 命名以 `_` 开头的文件夹下所有文件。例如：`_utils/index.ts`、`_utils/cp.ts`。
-* 测试文件。例如：`foo.test.ts`。
-* TypeScript 类型文件。例如：`hello.d.ts`。
-* `node_module` 下的文件。
+- 命名以 `_` 开头的文件。例如：`_utils.ts`。
+- 命名以 `_` 开头的文件夹下所有文件。例如：`_utils/index.ts`、`_utils/cp.ts`。
+- 测试文件。例如：`foo.test.ts`。
+- TypeScript 类型文件。例如：`hello.d.ts`。
+- `node_module` 下的文件。
 
 ## 函数定义
 

package/zh/apis/app/hooks/api/functions/api.md

@@ -1,5 +1,5 @@
 ---
-title: "**/*.[tj]s"
+title: '**/*.[tj]s'
 sidebar_position: 1
 ---
 
@@ -17,23 +17,23 @@ sidebar_position: 1
 
 路由系统会将以 `index` 命名的文件会被映射到上一层目录。
 
-* `api/index.ts` -> `$BASENAME/`
-* `api/user/index.ts` -> `$BASENAME/user`
+- `api/index.ts` -> `$BASENAME/`
+- `api/user/index.ts` -> `$BASENAME/user`
 
 ### 嵌套路由
 
 路由系统也支持解析嵌套的文件，如果创建嵌套文件夹结构，文件仍会以相同方式自动解析路由。
 
-* `api/hello.ts` -> `$BASENAME/hello`
-* `api/user/list.ts` -> `$BASENAME/user/list`
+- `api/hello.ts` -> `$BASENAME/hello`
+- `api/user/list.ts` -> `$BASENAME/user/list`
 
 ### 动态路由
 
 同样的，你可以通过创建带有 `[xxx]` 的文件夹或者文件来支持动态的命名路由参数。
 
-* `api/user/[username]/info.ts` -> `$BASENAME/user/:username/info`
-* `api/user/[username]/delete.ts` -> `$BASENAME/user/:username/delete`
-* `api/article/[id]/info.ts` -> `$BASENAME/article/:id/info`
+- `api/user/[username]/info.ts` -> `$BASENAME/user/:username/info`
+- `api/user/[username]/delete.ts` -> `$BASENAME/user/:username/delete`
+- `api/article/[id]/info.ts` -> `$BASENAME/article/:id/info`
 
 其中的 `$BASENAME` 可以在 `modern.config.js` 中进行配置，默认值为 `/api`。
 
@@ -41,11 +41,11 @@ sidebar_position: 1
 
 默认 `api` 目录下所有文件都会当作 BFF 函数文件去解析，但同样我们也设置了白名单，这些文件不被被解析：
 
-* 命名以 `_` 开头的文件。例如：`_utils.ts`。
-* 命名以 `_` 开头的文件夹下所有文件。例如：`_utils/index.ts`、`_utils/cp.ts`。
-* 测试文件。例如：`foo.test.ts`。
-* TypeScript 类型文件。例如：`hello.d.ts`。
-* `node_module` 下的文件。
+- 命名以 `_` 开头的文件。例如：`_utils.ts`。
+- 命名以 `_` 开头的文件夹下所有文件。例如：`_utils/index.ts`、`_utils/cp.ts`。
+- 测试文件。例如：`foo.test.ts`。
+- TypeScript 类型文件。例如：`hello.d.ts`。
+- `node_module` 下的文件。
 
 ## 函数定义
 

package/zh/apis/app/hooks/api/functions/app.md

@@ -8,5 +8,3 @@ sidebar_position: 3
 :::note
 具体示例请参考 [hook](/docs/apis/app/runtime/bff/hook)
 :::
-
-

package/zh/apis/app/hooks/api/functions/common.md

@@ -1,5 +1,5 @@
 ---
-title: "**/_*.[tj]s, _*/**"
+title: '**/_*.[tj]s, _*/**'
 sidebar_position: 2
 ---
 

package/zh/apis/app/hooks/index.md

@@ -5,8 +5,3 @@ type: ref
 # 文件约定
 
 本节涵盖了使用应用工程的所有文件约定。
-
-
-
-
-

package/zh/apis/app/hooks/shared.md

@@ -4,4 +4,3 @@ sidebar_position: 5
 ---
 
 共享源码目录。当项目在 `api/`、`server/`、`src/` 下有公共代码时，可将这些代码放到 shared 目录下，而不是直接引用。
-

package/zh/apis/app/hooks/src/app.md

@@ -13,33 +13,40 @@ import { createApp, bootstrap } from '@modern-js/runtime';
 // App.[jt]sx
 import App from '@_modern_js_src/App';
 import { state } from '@modern-js/runtime/plugins';
-import { immer, effects, autoActions, devtools } from '@modern-js/runtime/model';
+import {
+  immer,
+  effects,
+  autoActions,
+  devtools,
+} from '@modern-js/runtime/model';
 
-const createStatePlugins = (config) => {
+const createStatePlugins = config => {
   const plugins = [];
   plugins.push(immer(config['immer']));
   plugins.push(effects(config['effects']));
   plugins.push(autoActions(config['autoActions']));
   plugins.push(devtools(config['devtools']));
   return plugins;
-}
+};
 let AppWrapper = null;
 function render() {
   AppWrapper = createApp({
     plugins: [
-     state({...{plugins: createStatePlugins(true)}, ...App?.config?.state}),
-    ]
-  })(App)
+      state({
+        ...{ plugins: createStatePlugins(true) },
+        ...App?.config?.state,
+      }),
+    ],
+  })(App);
   if (IS_BROWSER) {
     bootstrap(AppWrapper, MOUNT_ID);
   }
-  return AppWrapper
+  return AppWrapper;
 }
 AppWrapper = render();
-export default AppWrapper;;
+export default AppWrapper;
 ```
 
-
 :::note
 在多入口的场景下，每个入口都可以拥有独立的 `App.[jt]sx`，详见[入口](/docs/guides/concept/entries)。
 :::

package/zh/apis/app/hooks/src/index_.md

@@ -21,12 +21,10 @@ export default (App: React.ComponentType) => {
 };
 ```
 
-
 2. 完全接管 webpack 入口:
 
 当 `src/index.[tj]sx?` 下没有默认导出函数时，该文件即为真正的 webpack 打包入口文件, 可以直接像使用 create-react-app 等脚手架一样组织代码:
 
-
 ```js title=src/index.jsx
 import React from 'react';
 import ReactDOM from 'react-dom/client';

package/zh/apis/app/hooks/src/routes.md

@@ -8,6 +8,7 @@ sidebar_position: 2
 当项目结构为 `Routes 入口` 类型时， 会分析 `src/routes` 目录下的文件得到客户端路由配置。具体用法请查看[约定式路由](/docs/guides/basic-features/routes)
 
 任何在 `src/routes` 下的 `layout.[tj]sx` 和 `page.[tj]sx` 都会作为应用的路由：
+
 ```bash {3}
 .
 └── routes
@@ -31,12 +32,14 @@ sidebar_position: 2
 ```
 
 会产出下面两条路由：
+
 - `/`
 - `/user`
 
 ## 动态路由
 
 如果路由文件的目录名以 `[]` 命名，生成的路由会作为动态路由。例如以下文件目录：
+
 ```
 └── routes
     ├── [id]
@@ -52,7 +55,6 @@ sidebar_position: 2
 
 在 loader 中，params 会作为 [loader](/docs/guides/basic-features/data-fetch#loader-函数) 的入参，通过 `params` 的属性可以获取到对应的参数。
 
-
 ## 布局组件
 
 如下面的例子，可以通过添加 `layout.tsx`，为所有路由组件添加公共的布局组件：
@@ -68,6 +70,7 @@ sidebar_position: 2
 ```
 
 在布局组件中可以通过使用 `<Outlet>` 表示子组件：
+
 ```tsx title=routes/layout.tsx
 import { Link, Outlet, useLoaderData } from '@modern-js/runtime/router';
 
@@ -76,14 +79,10 @@ export default () => {
     <>
       <Outlet></Outlet>
     </>
-  )
-}
+  );
+};
 ```
 
 :::note
 `<Outlet>` 是 React Router 6 中新的 API，详情可以查看 [Outlet](https://reactrouter.com/en/main/components/outlet#outlet).
 :::
-
-
-
-

package/zh/apis/app/hooks/src/server.md

@@ -1,5 +1,5 @@
 ---
-title: "*.[server|node].[tj]sx"
+title: '*.[server|node].[tj]sx'
 sidebar_position: 8
 ---
 
@@ -14,12 +14,14 @@ sidebar_position: 8
 import { useLoaderData } from '@modern-js/runtime/router';
 import { readFile } from './utils.server';
 
-type ProfileData = { /* some type declarations */ }
+type ProfileData = {
+  /* some type declarations */
+};
 
-export const loader = async(): ProfileData => {
+export const loader = async (): ProfileData => {
   const profile = await readFile('profile.json');
   return profile;
-}
+};
 
 export default function UserPage() {
   const profileData = useLoaderData() as ProfileData;

package/zh/apis/app/hooks/src/stories.md

@@ -1,5 +1,5 @@
 ---
-title: "**/*.stories.[tj]sx"
+title: '**/*.stories.[tj]sx'
 sidebar_position: 7
 ---
 

package/zh/apis/app/hooks/src/test.md

@@ -1,5 +1,5 @@
 ---
-title: "**/*.test.[tj]sx?"
+title: '**/*.test.[tj]sx?'
 sidebar_position: 6
 ---
 

package/zh/apis/app/runtime/app/define-config.md

@@ -22,7 +22,7 @@ Runtime 配置通常可以在 `modern.config.js` 的 `runtime` 空间下配置
 ## 函数签名
 
 ```ts
-function defineConfig(Component, config): any
+function defineConfig(Component, config): any;
 ```
 
 ### 参数
@@ -44,7 +44,6 @@ defineConfig(App, {
 })
 ```
 
-
 1. `defineConfig` 里可配置 [runtime.state](/docs/configure/app/runtime/state)、[runtime.router](/docs/configure/app/runtime/router) 等运行时配置。
 
 2. `defineConfig` 在配置某个属性之前，如 `router`，需要确保 `modern.config.js` 已经配置开启了该功能。