@modern-js/main-doc 0.0.0-next-20221227140603 → 0.0.0-next-20221228071505

package/en/docusaurus-plugin-content-docs/current/components/enable-bff.md

@@ -0,0 +1,36 @@
+1. Execute `pnpm new` and select "Enable BFF"
+2. Add the following code to `modern.config.[tj]s` according to the chosen runtime framework：
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs>
+  <TabItem value="express" label="Express.js" default>
+
+```ts title="edenx.config.ts"
+import ExpressPlugin from '@edenx/plugin-express';
+import BffPlugin from '@edenx/plugin-bff';
+
+export default defineConfig({
+  plugins: [
+    ExpressPlugin(),
+    BffPlugin()
+  ]
+})
+```
+  </TabItem>
+  <TabItem value="koa" label="Koa.js">
+
+```ts title="edenx.config.ts"
+import KoaPlugin from '@edenx/plugin-koa';
+import BffPlugin from '@edenx/plugin-bff';
+
+export default defineConfig({
+  plugins: [
+    KoaPlugin(),
+    BffPlugin()
+  ]
+})
+```
+  </TabItem>
+</Tabs>

package/en/docusaurus-plugin-content-docs/current/components/router-legacy-tip.md

@@ -0,0 +1 @@
+

package/en/docusaurus-plugin-content-docs/current/configure/app/runtime/router.md

@@ -2,18 +2,33 @@
 sidebar_label: router
 ---
 
+import RouterLegacyTip from '@site-docs/components/router-legacy-tip.md'
+
+<RouterLegacyTip />
+
 # runtime.router
 
 * Type: `boolean | Object`
 * Default: `false`。
 
-When `router` is enabled, routing management using conventional routes provided by Modern.js default is supported.
+When `router` is enabled, routing management of conventional routes provided by Modern.js is supported. Based on [React Router 6](https://reactrouter.com/).
 
 ## Configuration
 
+### basename
+
+* Type: `string`
+* Default: ``
+
+The basename of the app for situations where you can't deploy to the root of the domain, but a sub directory.
+
 ### supportHtml5History
 
 * Type: `Boolean`
 * Default: `true`
 
-If the value of `supportHtml5History` is `true`, the project will use `BrowserRouter`, otherwise `HashRouter`.
+If the value of `supportHtml5History` is `true`, `BrowserRouter` would be used, otherwise `HashRouter` would be used. `BrowserRouter` is recommended.
+
+:::warning
+When SSR is enabled, `supportHtml5History` is not supported.
+:::

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/bff/frameworks.md

@@ -3,6 +3,8 @@ sidebar_position: 3
 title: Frameworks
 ---
 
+Modern.js's BFF supports different runtime frameworks, currently Modern.js's BFF supports two runtime frameworks[Express.js](https://expressjs.com/) 和 [Koa.js](https://koajs.com/).
+
 ## Function Writing
 
 Under the function writing, only the middleware writing method of various runtime frameworks is different, and other implementations are basically the same. Take Express as an example to introduce how to write a middleware by hand in the `api/_ app.ts` and add permission verification:

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/bff/function.md

@@ -1,13 +1,15 @@
 ---
 sidebar_position: 1
-title: Integration
+title: Basic Usage
 ---
 
-Modern.js allow functions that meet certain conditions in the `api/` directory to be directly called in the React component, which is called **integration**.
+Applications developed with Modern.js can define API functions in the `api/` directory, which can be called by the front-end to send requests without writing front and back-end glue layer code, At the same time, it ensures the type safety of the front and back end
 
-:::note
-The use of integration calls requires the enable BFF first.
-:::
+## Enable BFF
+
+import EnableBFF from '@site-docs-en/components/enable-bff.md'
+
+<EnableBFF/>
 
 ## BFF Function
 
@@ -41,7 +43,9 @@ The functions import in `src/App.tsx` will be automatically converted into inter
 
 Execute `pnpm run dev`, then open `http://localhost:8080/` to see that the page has displayed the content returned by the BFF function. In Network, you can see that the page sent a request to `http://localhost:8080/api/hello`.
 
-## Function Route
+![Network](https://p6-piu.byteimg.com/tos-cn-i-8jisjyls3a/fd41750f8d414179a9b4ecb519919b36~tplv-8jisjyls3a-3:0:0:q75.png)
+
+## API Routes
 
 In Modern.js, the BFF function routing system is implemented based on the file system, and it is also a conventional routing system.
 

package/en/docusaurus-plugin-content-docs/current/guides/basic-features/data-fetch.md

@@ -242,6 +242,7 @@ First, add a `loading.tsx` component to the `routes` directory in your project,
 .
 └── routes
     ├── layout.tsx
+    ├── loading.tsx
     └── user
         ├── layout.tsx
         └── page.ts

package/en/docusaurus-plugin-content-docs/current/guides/basic-features/routes.md

@@ -243,8 +243,6 @@ export default () => {
 
 :::note
 Under self-controlled routing, if developers want to use the [Loader API](https://reactrouter.com/en/main/hooks/use-loader-data#useloaderdata) capabilities in React Router 6 in SSR will be relatively complicated, it is recommended to use conventional routing directly. Modern.js has already encapsulated everything for you.
-<!-- Todo 嵌套路由带来的优化可以补充下文档-->
-If the project only wants to upgrade to React Router 6 and does not want to use the optimizations brought by nested routing, then [useLoader](/docs/apis/app/runtime/core/use-loader) will still work under SSR.
 :::
 
 ## Other

package/package.json

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