@modern-js/main-doc 2.8.0 → 2.9.0

package/zh/configure/app/tools/dev-server.mdx

@@ -8,6 +8,6 @@ sidebar_label: devServer
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.devServer](https://modernjs.dev/builder/api/config-tools.html#toolsdevserver)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/devServer.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/devServer.md';
 
 <Main />

package/zh/configure/app/tools/html-plugin.mdx

@@ -8,6 +8,6 @@ sidebar_label: htmlPlugin
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.htmlPlugin](https://modernjs.dev/builder/api/config-tools.html#toolshtmlplugin)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/htmlPlugin.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/htmlPlugin.md';
 
 <Main />

package/zh/configure/app/tools/inspector.mdx

@@ -8,6 +8,6 @@ sidebar_label: inspector
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.inspector](https://modernjs.dev/builder/api/config-tools.html#toolsinspector)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/inspector.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/inspector.md';
 
 <Main />

package/zh/configure/app/tools/less.mdx

@@ -8,6 +8,6 @@ sidebar_label: less
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.less](https://modernjs.dev/builder/api/config-tools.html#toolsless)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/less.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/less.md';
 
 <Main />

package/zh/configure/app/tools/minify-css.mdx

@@ -8,6 +8,6 @@ sidebar_label: minifyCss
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.minifyCss](https://modernjs.dev/builder/api/config-tools.html#toolsminifycss)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/minifyCss.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/minifyCss.md';
 
 <Main />

package/zh/configure/app/tools/postcss.mdx

@@ -8,6 +8,6 @@ sidebar_label: postcss
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.postcss](https://modernjs.dev/builder/api/config-tools.html#toolspostcss)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/postcss.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/postcss.md';
 
 <Main />

package/zh/configure/app/tools/pug.mdx

@@ -8,6 +8,6 @@ sidebar_label: pug
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.pug](https://modernjs.dev/builder/api/config-tools.html#toolspug)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/pug.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/pug.md';
 
 <Main />

package/zh/configure/app/tools/rspack.mdx

@@ -8,6 +8,6 @@ sidebar_label: rspack
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.rspack](https://modernjs.dev/builder/api/config-tools.html#toolsrspack)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/rspack.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/rspack.md';
 
 <Main />

package/zh/configure/app/tools/sass.mdx

@@ -8,6 +8,6 @@ sidebar_label: sass
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.sass](https://modernjs.dev/builder/api/config-tools.html#toolssass)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/sass.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/sass.md';
 
 <Main />

package/zh/configure/app/tools/style-loader.mdx

@@ -8,6 +8,6 @@ sidebar_label: styleLoader
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.styleLoader](https://modernjs.dev/builder/api/config-tools.html#toolsstyleloader)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/styleLoader.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/styleLoader.md';
 
 <Main />

package/zh/configure/app/tools/styled-components.mdx

@@ -8,6 +8,6 @@ sidebar_label: styledComponents
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.styledComponents](https://modernjs.dev/builder/api/config-tools.html#toolsstyledcomponents)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/styledComponents.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/styledComponents.md';
 
 <Main />

package/zh/configure/app/tools/terser.mdx

@@ -8,6 +8,6 @@ sidebar_label: terser
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.terser](https://modernjs.dev/builder/api/config-tools.html#toolsterser)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/terser.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/terser.md';
 
 <Main />

package/zh/configure/app/tools/ts-checker.mdx

@@ -8,6 +8,6 @@ sidebar_label: tsChecker
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.tsChecker](https://modernjs.dev/builder/api/config-tools.html#toolstschecker)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsChecker.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsChecker.md';
 
 <Main />

package/zh/configure/app/tools/ts-loader.mdx

@@ -8,6 +8,6 @@ sidebar_label: tsLoader
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.tsLoader](https://modernjs.dev/builder/api/config-tools.html#toolstsloader)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsLoader.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsLoader.md';
 
 <Main />

package/zh/configure/app/tools/webpack-chain.mdx

@@ -8,6 +8,6 @@ sidebar_label: webpackChain
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.webpackChain](https://modernjs.dev/builder/api/config-tools.html#toolswebpackchain)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpackChain.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpackChain.md';
 
 <Main />

package/zh/configure/app/tools/webpack.mdx

@@ -8,6 +8,6 @@ sidebar_label: webpack
 该配置由 Modern.js Builder 提供，更多信息可参考 [tools.webpack](https://modernjs.dev/builder/api/config-tools.html#toolswebpack)。
 :::
 
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpack.md'
+import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpack.md';
 
 <Main />

package/.eslintrc.js

@@ -1,12 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ['@modern-js'],
-  parserOptions: {
-    tsconfigRootDir: __dirname,
-    project: ['./tsconfig.json'],
-  },
-  rules: {
-    'babel/no-unused-expressions': 0,
-    'react/jsx-filename-extension': 0,
-  },
-};

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @modern-js/main-doc@2.8.0 build /home/runner/work/modern.js/modern.js/packages/toolkit/main-doc
-> npx ts-node ./scripts/sync.ts
-

package/en/apis/app/hooks/api/framework/lambda.mdx

@@ -1,57 +0,0 @@
----
-title: lambda/*.[tj]s
-sidebar_position: 1
----
-# lambda/*.[tj]s
-
-Declaring API routing in BFF framework mode. Except [some files](/apis/app/hooks/api/framework/lambda#allow-list)，files in `api/` are registered as routes.
-
-:::info
-use `api/` need execute new command to enable the 「BFF」 feature.
-
-:::
-
-:::tip
-this file supports the use `js` or `ts`, but the functions must be exported using the ESM syntax.
-
-:::
-
-## Routing Rule
-
-### Default Route
-
-The files named `index` will be upper level routing:
-
-- `api/lambda/index.ts` -> `$BASENAME/`
-- `api/lambda/user/index.ts` -> `$BASENAME/user`
-
-### Multi Level Route
-
-The routing system also supports parsing multiple levels of files. and if you create a folder, the files will still be automatically parsed in the same way.
-
-- `api/lambda/hello.ts` -> `$BASENAME/hello`
-- `api/lambda/user/list.ts` -> `$BASENAME/user/list`
-
-### Dynamic Route
-
-Dynamic named routing parameters can be supported by creating folders or files with `[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`
-
-the `$BASENAME` can be configured in `modern.config.js`，the default value is `/api`.
-
-### Allow List
-
-By default, all files in the `api/` will be parsed as BFF function. but we also set a allow list, and these files will not be parsed:
-
-- file name start with `_`, for example: `_utils.ts`.
-- files in directory that name start with `_`, for example：`_utils/index.ts`、`_utils/cp.ts`.
-- test files, for example：`foo.test.ts`.
-- TypeScript define files, for example：`hello.d.ts`.
-- files in `node_module`.
-
-## Define Function
-
-the same as [Define Function](/apis/app/hooks/api/functions/api#define-function).

package/en/apis/app/hooks/api/functions/api.mdx

@@ -1,81 +0,0 @@
----
-title: '**/*.[tj]s'
-sidebar_position: 1
----
-# **/*.[tj]s
-
-Declaring API routing in BFF function mode. Except [some files](/apis/app/hooks/api/functions/api#allow-list)，files in `api/` are registered as routes.
-
-:::info
-use `api/` need execute new command to enable the 「BFF」 feature.
-
-:::
-
-:::tip
-this file supports the use `js` or `ts`, but the functions must be exported using the ESM syntax.
-
-:::
-
-## Routing Rule
-
-### Default Route
-
-The files named `index` will be upper level routing:
-
-- `api/index.ts` -> `$BASENAME/`
-- `api/user/index.ts` -> `$BASENAME/user`
-
-### Multi Level Route
-
-The routing system also supports parsing multiple levels of files. and if you create a folder, the files will still be automatically parsed in the same way.
-
-- `api/hello.ts` -> `$BASENAME/hello`
-- `api/user/list.ts` -> `$BASENAME/user/list`
-
-### Dynamic Route
-
-Dynamic named routing parameters can be supported by creating folders or files with `[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`
-
-the `$BASENAME` can be configured in `modern.config.js`，the default value is `/api`.
-
-### Allow List
-
-By default, all files in the `api/` will be parsed as BFF function. but we also set a allow list, and these files will not be parsed:
-
-- file name start with `_`, for example: `_utils.ts`.
-- files in directory that name start with `_`, for example：`_utils/index.ts`、`_utils/cp.ts`.
-- test files, for example：`foo.test.ts`.
-- TypeScript define files, for example：`hello.d.ts`.
-- files in `node_module`.
-
-## Define Function
-
-In addition to the above routing rules, the function definition and export in the code also have conventions.
-
-function need named exports，and the name of the exported function is the HTTP Method:
-
-```ts
-export const get = async () => {
-  return {
-    name: 'Modern.js',
-    desc: 'Modern web Solutions',
-  };
-};
-```
-
-Export the function like above will generate a `POST` interface.
-
-App support 9 Method definitions: `GET`、`POST`、`PUT`、`DELETE`、`CONNECT`、`TRACE`、`PATCH`、`OPTION`、`HEAD`. so App can use these name as function export nane.
-
-The name is insensitive, whaterver `get`、`Get`、`GEt`、`GET`, can be accurately identified. And default export, `export default xxx` will be `Get` method.
-
-because `delete` is a keyword in JavaScript, use `del` or `DELETE` instead.
-
-Multiple functions of different Methods can be defined in one file, but if multiple functions of the same Method are defined, only the first can work.
-
-:::info
-It should be noted that the defined functions should be asynchronous, which is related to the type when the function is called.

package/en/apis/app/hooks/src/routes.mdx

@@ -1,90 +0,0 @@
----
-title: routes/
-sidebar_position: 2
----
-# routes/
-
-The entry identifier when the application uses file system-based routing.
-
-When the project structure is of type `Routes directory entry`, the files in the `src/routes` directory are parsed to get the client-side routing configuration. See [Routing by convention](/guides/basic-features/routes) for more details on usage.
-
-Any `layout.[tj]sx` and `page.[tj]sx` under `src/routes` will be used as a route to the application：
-
-```bash {3}
-.
-└── routes
-    ├── layout.tsx
-    ├── page.tsx
-    └── user
-        ├── layout.tsx
-        └── page.tsx
-```
-
-## basic example
-
-The directory names in the `routes` directory will be used as a mapping of the route url, where `layout.tsx` is used as the layout component and `page.tsx` as the content component, which is a leaf node of the whole route, for example the following directory structure：
-
-```bash
-.
-└── routes
-    ├── page.tsx
-    └── user
-        └── page.tsx
-```
-
-The following two routes are produced:
-
-- `/`
-- `/user`
-
-## Dynamic Route
-
-If the directory name of the route file is named with `[]`, the generated route will be used as a dynamic route. For example, the following file directories:
-
-```
-└── routes
-    ├── [id]
-    │   └── page.tsx
-    ├── blog
-    │   └── page.tsx
-    └── page.tsx
-```
-
-The `routes/[id]/page.tsx` file will be converted to a `/:id` route. All `/xxx` will match that route, except for the `/blog` route, which can be matched exactly.
-
-In the component, you can get the corresponding parameters by [useParams](/apis/app/runtime/router/router#useparams).
-
-In the loader, params will be used as input to [loader](/guides/basic-features/data-fetch#loader-function), and the corresponding parameters can be retrieved through the property `params`.
-
-## Layout component
-
-As in the example below, you can add a common layout component for all routing components by adding `layout.tsx`
-
-```bash
-.
-└── routes
-    ├── layout.tsx
-    ├── page.tsx
-    └── user
-        ├── layout.tsx
-        └── page.tsx
-```
-
-You can represent child components in layout components by using `<Outlet>`:
-
-```tsx title=routes/layout.tsx
-import { Link, Outlet, useLoaderData } from '@modern-js/runtime/router';
-
-export default () => {
-  return (
-    <>
-      <Outlet></Outlet>
-    </>
-  );
-};
-```
-
-:::note
-`<Outlet>` is a new API in React Router 6, see [Outlet] for details(https://reactrouter.com/en/main/components/outlet#outlet).
-
-:::

package/en/apis/app/hooks/src/server.mdx

@@ -1,34 +0,0 @@
----
-title: '*.[server|node].[tj]sx'
-sidebar_position: 8
----
-# *.[server|node].[tj]sx
-
-Used in application projects to place server side code, it generally has the following two functions：
-
-1. When `*.tsx` and `*. [server|node].tsx` coexist, rendering on the server side will give preference to the `*. [server|node].tsx` file instead of the `*.tsx` file.
-
-2. When using [data loader](/guides/basic-features/data-fetch), the server-side dependencies need to be re-exported from this file
-
-```tsx
-// routes/user/avatar.tsx
-import { useLoaderData } from '@modern-js/runtime/router';
-import { readFile } from './utils.server';
-
-type ProfileData = {
-  /* some type declarations */
-};
-
-export const loader = async (): ProfileData => {
-  const profile = await readFile('profile.json');
-  return profile;
-};
-
-export default function UserPage() {
-  const profileData = useLoaderData() as ProfileData;
-  return <div>{profileData}</div>;
-}
-
-// routes/user/utils.server.ts
-export * from 'fs-extra';
-```