@modern-js/main-doc 0.0.0-next-1686556197370 → 0.0.0-next-1686559924703

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @modern-js/main-doc
 
-## 0.0.0-next-1686556197370
+## 0.0.0-next-1686559924703
 
 ### Patch Changes
 
@@ -24,12 +24,12 @@
 
   docs(main): 更新 HTML 模板文档
 
-- d6625cb47: docs(main): update bff config doc
+- d67b665c9: docs(main): update bff config doc
 
   docs(main): 更新 BFF 配置文档
 
 - Updated dependencies [7e6fb5fc1]
-  - @modern-js/builder-doc@0.0.0-next-1686556197370
+  - @modern-js/builder-doc@0.0.0-next-1686559924703
 
 ## 2.22.1
 

package/docs/en/components/bff-proxy-path-rewrite.mdx

@@ -0,0 +1,16 @@
+Path rewriting can also be performed here, such as proxying the request sent to `localhost:8080/api/topics` to `https://cnodejs.org/api/v1/topics`.
+
+```js title="modern.server-runtime.config.js"
+import { defineConfig } from '@modern-js/app-tools/server';
+export default defineConfig({
+  bff: {
+    proxy: {
+      '/api': {
+        target: 'https://cnodejs.org',
+        pathRewrite: { '/api/topics': '/api/v1/topics' },
+        changeOrigin: true,
+      },
+    },
+  },
+});
+```

package/docs/en/components/bff-proxy-principle.mdx

@@ -0,0 +1 @@
+BFF Proxy uses the powerful [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware). For more advanced usage, please refer to its [documentation](https://github.com/chimurai/http-proxy-middleware#options).

package/docs/en/configure/app/bff/proxy.mdx

@@ -13,8 +13,6 @@ import EnableBFFCaution from "@site-docs-en/components/enable-bff-caution";
 
 With simple configuration, Modern.js can automatically proxy requests sent to the BFF server to the specified service.
 
-BFF Proxy uses the powerful [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware). For more advanced usage, please refer to its [documentation](https://github.com/chimurai/http-proxy-middleware#options).
-
 Add the following configuration to `modern.server-runtime.config.js` to enable proxy:
 
 ```ts title="modern.server-runtime.config.ts"
@@ -30,28 +28,15 @@ export default defineConfig({
 
 Assuming the address of Modern.js BFF server is `localhost:8080`, all requests starting with `api` will be proxied to `https://cnodejs.org`, for example, the request to `localhost:8080/api/v1/topics` will be proxied to `https://cnodejs.org/api/v1/topics`.
 
-Path rewriting can also be performed here, such as proxying the request sent to `localhost:8080/api/topics` to `https://cnodejs.org/api/v1/topics`.
+import BFFProxyPathRewrite from "@site-docs/components/bff-proxy-path-rewrite";
 
-```js title="modern.server-runtime.config.js"
-import { defineConfig } from '@modern-js/app-tools/server';
-export default defineConfig({
-  bff: {
-    proxy: {
-      '/api': {
-        target: 'https://cnodejs.org',
-        pathRewrite: { '/api/topics': '/api/v1/topics' },
-        changeOrigin: true,
-      },
-    },
-  },
-});
-```
+<BFFProxyPathRewrite />
 
 Unlike [dev.proxy](/configure/app/dev/proxy), the proxy here only applies to requests entering the BFF/API service; at the same time, this configuration can not only be used in the development environment, but also proxies corresponding requests in the production environment.
 
-import BFFProxyOtherConfig from "@site-docs-en/components/bff-proxy-other-config";
+import BFFProxyPrinciple from "@site-docs/components/bff-proxy-principle";
 
-<BFFProxyOtherConfig />
+<BFFProxyPrinciple />
 
 ## Common Usage
 

package/docs/zh/components/bff-proxy-path-rewrite.mdx

@@ -0,0 +1,16 @@
+这里还可以进行路径重写，如将发送到 `localhost:8080/api/topics` 的请求代理到 `https://cnodejs.org/api/v1/topics`。
+
+```ts title="modern.server-runtime.config.ts"
+import { defineConfig } from '@modern-js/app-tools/server';
+export default defineConfig({
+  bff: {
+    proxy: {
+      '/api': {
+        target: 'https://cnodejs.org',
+        pathRewrite: { '/api/topics': '/api/v1/topics' },
+        changeOrigin: true,
+      },
+    },
+  },
+});
+```

package/docs/zh/components/bff-proxy-principle.mdx

@@ -0,0 +1 @@
+BFF Proxy 使用了强大的 [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware)，如果需要更多高级的用法， 可以查看它的[文档](https://github.com/chimurai/http-proxy-middleware#options)。

package/docs/zh/configure/app/bff/proxy.mdx

@@ -12,7 +12,6 @@ import EnableBFFCaution from "@site-docs/components/enable-bff-caution";
 <EnableBFFCaution />
 
 通过简单配置，Modern.js 可以将发送给 BFF server 的请求，自动代理到指定的服务上。
-BFF Proxy 使用了强大的 [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware)，如果需要更多高级的用法， 可以查看它的[文档](https://github.com/chimurai/http-proxy-middleware#options)。
 
 在 `modern.server-runtime.config.js` 中加入以下配置；即可开启代理：
 
@@ -29,28 +28,15 @@ export default defineConfig({
 
 假设 Modern.js BFF server 的地址是 `localhost:8080`，所有以 `api` 开头的请求都会被代理到 `https://cnodejs.org`，如 `localhost:8080/api/v1/topics` 的请求会被代理到 `https://cnodejs.org/api/v1/topics`。
 
-这里还可以进行路径重写，如将发送到 `localhost:8080/api/topics` 的请求代理到 `https://cnodejs.org/api/v1/topics`。
+import BFFProxyPathRewrite from "@site-docs/components/bff-proxy-path-rewrite";
 
-```ts title="modern.server-runtime.config.ts"
-import { defineConfig } from '@modern-js/app-tools/server';
-export default defineConfig({
-  bff: {
-    proxy: {
-      '/api': {
-        target: 'https://cnodejs.org',
-        pathRewrite: { '/api/topics': '/api/v1/topics' },
-        changeOrigin: true,
-      },
-    },
-  },
-});
-```
+<BFFProxyPathRewrite />
 
 与 [dev.proxy](/configure/app/dev/proxy) 不同，本节所介绍的代理只作用于进入 BFF/API 服务的请求；同时，这一配置不但可以在开发环境中使用，在生产环境中也会代理相应的请求。
 
-import BFFProxyOtherConfig from "@site-docs/components/bff-proxy-other-config";
+import BFFProxyPrinciple from "@site-docs/components/bff-proxy-principle";
 
-<BFFProxyOtherConfig />
+<BFFProxyPrinciple />
 
 ## 常见用法
 

package/package.json

@@ -15,14 +15,14 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-1686556197370",
+  "version": "0.0.0-next-1686559924703",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public",
     "provenance": true
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-1686556197370"
+    "@modern-js/builder-doc": "0.0.0-next-1686559924703"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -34,9 +34,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-1686556197370",
-    "@modern-js/doc-tools": "0.0.0-next-1686556197370",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686556197370"
+    "@modern-js/builder-doc": "0.0.0-next-1686559924703",
+    "@modern-js/doc-tools": "0.0.0-next-1686559924703",
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686559924703"
   },
   "scripts": {
     "dev": "modern dev",