From 70b9f262013e3684e3768f461982cb0c5b02f688 Mon Sep 17 00:00:00 2001
From: Dlouxgit <57781857+Dlouxgit@users.noreply.github.com>
Date: Wed, 20 Sep 2023 15:38:10 +0800
Subject: [PATCH 1/2] fix(docs): fixed the bug where the documentation
redirects to a not found page after deployment (#696)
---
website/docs/faq.md | 12 ++++++------
website/docs/guide.md | 4 ++--
website/docs/guide/micro-module.md | 2 +-
website/docs/guide/use-child/others.md | 4 ++--
website/docs/guide/use-layout/react.md | 2 +-
website/docs/guide/use-layout/vue.md | 2 +-
6 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/website/docs/faq.md b/website/docs/faq.md
index 8ea579cc..8494d925 100644
--- a/website/docs/faq.md
+++ b/website/docs/faq.md
@@ -119,7 +119,7 @@ module.exports = {
## Error: Invariant failed: You should not use `` outside a ``
-因为 jsx 嵌套层级的关系,在主应用的 Layout 里没法使用 react-router 提供的 API,比如 `withRouter`, `Link`, `useParams` 等,具体参考文档 [主应用中路由跳转](./guide/use-layout/react#主应用中路由跳转)。
+因为 jsx 嵌套层级的关系,在主应用的 Layout 里没法使用 react-router 提供的 API,比如 `withRouter`, `Link`, `useParams` 等,具体参考文档 [主应用中路由跳转](guide/use-layout/react#主应用中路由跳转)。
## 官方 Demo 如何启用 HashRouter
@@ -274,7 +274,7 @@ appHistory.push('/seller', true);
2. 添加 `fetch` polyfill
-当 [`loadScriptMode`](./api/ice-stark#loadscriptmode) 为 `fetch` 时,icestark 会使用 `window.fetch` 获取微应用静态资源,因此还需要对 `fetch` 进行 polyfill。这里,我们推荐 [whatwg-fetch](https://github.com/github/fetch)。请确保在 icestark 之前引入该资源。
+当 [`loadScriptMode`](api/ice-stark#loadscriptmode) 为 `fetch` 时,icestark 会使用 `window.fetch` 获取微应用静态资源,因此还需要对 `fetch` 进行 polyfill。这里,我们推荐 [whatwg-fetch](https://github.com/github/fetch)。请确保在 icestark 之前引入该资源。
```js
// 入口文件
@@ -301,7 +301,7 @@ proxy sandbox is not support by current browser
## 如何解决 Script Error
-“Script error.” 是一个常见错误,但由于该错误不提供完整的报错信息(错误堆栈),问题排查往往无从下手。icestark 的 [scriptAttributes](./api/ice-stark#scriptattributes) 参数支持为加载的 `` 资源添加 `crossorigin="anonymous"` 来解决这个问题。具体可参考 [scriptAttributes](./api/ice-stark#scriptattributes)。
+“Script error.” 是一个常见错误,但由于该错误不提供完整的报错信息(错误堆栈),问题排查往往无从下手。icestark 的 [scriptAttributes](api/ice-stark#scriptattributes) 参数支持为加载的 `` 资源添加 `crossorigin="anonymous"` 来解决这个问题。具体可参考 [scriptAttributes](api/ice-stark#scriptattributes)。
:::tip
想了解更多有关 Script Error 的问题,可以参考 “Script error.”的产生原因和解决办法
@@ -325,7 +325,7 @@ const Routes = () => {
}
```
-这样,不会导致微应用正常加载,但微应用路由没有匹配成功时导致的页面空白,而会显示 404 页面。这样,我们能清晰地知道,在 icestark 执行环境下,需要修改[微应用的 basename](./guide/use-child/react#2-定义基准路由),使得微应用可以与当前路由匹配上。
+这样,不会导致微应用正常加载,但微应用路由没有匹配成功时导致的页面空白,而会显示 404 页面。这样,我们能清晰地知道,在 icestark 执行环境下,需要修改[微应用的 basename](guide/use-child/react#2-定义基准路由),使得微应用可以与当前路由匹配上。
## Vite 微应用支持沙箱吗
@@ -338,7 +338,7 @@ const Routes = () => {
## 切换微应用,主应用样式丢失
-通常情况是主应用开启了 webpack [Dynamic Imports](https://webpack.js.org/guides/code-splitting/#dynamic-imports) 能力,可以通过 [shouldAssetsRemove](./api/ice-stark#shouldassetsremove) 防止错误地移除主应用的样式资源。
+通常情况是主应用开启了 webpack [Dynamic Imports](https://webpack.js.org/guides/code-splitting/#dynamic-imports) 能力,可以通过 [shouldAssetsRemove](api/ice-stark#shouldassetsremove) 防止错误地移除主应用的样式资源。
```js
// src/App.jsx
@@ -365,5 +365,5 @@ const App = () => {
## 主应用路由之间跳转导致重复渲染
-如果主应用需要包含路由页面,在 [React 主应用接入](./guide/use-layout/react#主应用中如何包含路由页面) 我们推荐将主应用路由作为一个 `fallback` 微应用来使用。但由于在主应用路由切换时,上层组件状态改变会导致 `fallback` 应用重复渲染,因此推荐使用 [React.memo](https://reactjs.org/docs/react-api.html#reactmemo) 防止 React 组件重复渲染。具体示例可参考 [主应用中如何包含路由页面](./guide/use-layout/react#主应用中如何包含路由页面)
+如果主应用需要包含路由页面,在 [React 主应用接入](guide/use-layout/react#主应用中如何包含路由页面) 我们推荐将主应用路由作为一个 `fallback` 微应用来使用。但由于在主应用路由切换时,上层组件状态改变会导致 `fallback` 应用重复渲染,因此推荐使用 [React.memo](https://reactjs.org/docs/react-api.html#reactmemo) 防止 React 组件重复渲染。具体示例可参考 [主应用中如何包含路由页面](guide/use-layout/react#主应用中如何包含路由页面)
diff --git a/website/docs/guide.md b/website/docs/guide.md
index 058ba5de..31a69f9b 100644
--- a/website/docs/guide.md
+++ b/website/docs/guide.md
@@ -15,7 +15,7 @@ icestark 在保证一个系统的操作体验基础上,实现各个微应用
icestark 可以通过简单的命令行,生成主应用和微应用模板。无论您是使用 React 还是 Vue,都可以便捷的创建符合 icestark 微前端规范的项目。这些项目均由 icestark 团队官方维护。
:::tip
-如果您想将正在开发中或已开发完成的项目接入 icestark,请移步[主应用接入](./guide/use-layout/react)和[微应用接入](./guide/use-child/react)。如果您使用的是 [create-react-app](https://github.com/facebook/create-react-app) 、umi 等框架开发的应用,亦可参考[其它框架的接入指南](./guide/use-child/others)。
+如果您想将正在开发中或已开发完成的项目接入 icestark,请移步[主应用接入](guide/use-layout/react)和[微应用接入](guide/use-child/react)。如果您使用的是 [create-react-app](https://github.com/facebook/create-react-app) 、umi 等框架开发的应用,亦可参考[其它框架的接入指南](guide/use-child/others)。
:::
### 初始化主应用
@@ -49,5 +49,5 @@ $ npm run start
+ 现代浏览器和 IE11。
:::tip
-对于 IE 系列浏览器,需要提供相应的 polyfill 支持。详细介绍,请参考[常见问题 -> 兼容 IE 浏览器](./faq#兼容-ie-浏览器)
+对于 IE 系列浏览器,需要提供相应的 polyfill 支持。详细介绍,请参考[常见问题 -> 兼容 IE 浏览器](faq#兼容-ie-浏览器)
:::
diff --git a/website/docs/guide/micro-module.md b/website/docs/guide/micro-module.md
index 691fb82d..484329af 100644
--- a/website/docs/guide/micro-module.md
+++ b/website/docs/guide/micro-module.md
@@ -182,7 +182,7 @@ export default function ExampleComponent(props) {
## 已有项目改造为微模块
-将已有项目改造为微模块的方式与 [微应用](./use-child/react) 类似,主要包含两步:
+将已有项目改造为微模块的方式与 [微应用](use-child/react) 类似,主要包含两步:
#### 1. 应用入口导出生命周期函数
diff --git a/website/docs/guide/use-child/others.md b/website/docs/guide/use-child/others.md
index 34af633a..b10338f6 100644
--- a/website/docs/guide/use-child/others.md
+++ b/website/docs/guide/use-child/others.md
@@ -8,7 +8,7 @@ order: 3
为一些使用 [`icejs`](https://ice.work/) 、[`create-react-app`](https://github.com/facebook/create-react-app)、umi 等三方框架的用户提供便利的接入指南。
:::tip
-如果这里找不到您使用的框架类型,建议您通过[微应用接入三步骤](./react#已有-react-项目改造为微应用)来改造您的应用。所有的改造逻辑都是相通的,也欢迎您提供 PR 介绍您的接入经验。
+如果这里找不到您使用的框架类型,建议您通过[微应用接入三步骤](react#已有-react-项目改造为微应用)来改造您的应用。所有的改造逻辑都是相通的,也欢迎您提供 PR 介绍您的接入经验。
:::
## icejs 应用
@@ -546,7 +546,7 @@ export default defineConfig({
### 配置基准路由
-对于基准路由的配置,可以依照 [React 微应用接入](./react#2-%E5%AE%9A%E4%B9%89%E5%9F%BA%E5%87%86%E8%B7%AF%E7%94%B1) 和 [Vue 微应用接入](./vue#2-%E5%AE%9A%E4%B9%89%E5%9F%BA%E5%87%86%E8%B7%AF%E7%94%B1) 相同的方式改造接入。
+对于基准路由的配置,可以依照 [React 微应用接入](react#2-%E5%AE%9A%E4%B9%89%E5%9F%BA%E5%87%86%E8%B7%AF%E7%94%B1) 和 [Vue 微应用接入](vue#2-%E5%AE%9A%E4%B9%89%E5%9F%BA%E5%87%86%E8%B7%AF%E7%94%B1) 相同的方式改造接入。
### 主应用加载 Vite 应用
diff --git a/website/docs/guide/use-layout/react.md b/website/docs/guide/use-layout/react.md
index 28cde415..99652d64 100644
--- a/website/docs/guide/use-layout/react.md
+++ b/website/docs/guide/use-layout/react.md
@@ -4,7 +4,7 @@
## 通过官方脚手架创建
-> 该官方脚手架基于 [icejs](https://ice.work/) 框架,如需使用其他框架/工程可按 [已有应用改造](./react#已有应用改造) 的方式接入。
+> 该官方脚手架基于 [icejs](https://ice.work/) 框架,如需使用其他框架/工程可按 [已有应用改造](react#已有应用改造) 的方式接入。
```bash
$ npm init ice icestark-layout @icedesign/stark-layout-scaffold
diff --git a/website/docs/guide/use-layout/vue.md b/website/docs/guide/use-layout/vue.md
index e3afaef5..97bc2e5c 100644
--- a/website/docs/guide/use-layout/vue.md
+++ b/website/docs/guide/use-layout/vue.md
@@ -4,7 +4,7 @@
## 通过官方脚手架创建
-> 该官方脚手架基于 Vue 2.0 + Vue CLI,如需使用其他框架/工程可按 [已有应用改造](./vue#已有应用改造) 的方式接入。
+> 该官方脚手架基于 Vue 2.0 + Vue CLI,如需使用其他框架/工程可按 [已有应用改造](vue#已有应用改造) 的方式接入。
> 需注意,目前 @vue-materials/icestark-layout-app 1.x 采用 Vite + icestark + vue3 框架应用。
```bash
From f4ba5c6b86df14d284d50e946962c4bbc6a0b8a7 Mon Sep 17 00:00:00 2001
From: huangzhenpeng
Date: Wed, 20 Sep 2023 15:39:03 +0800
Subject: [PATCH 2/2] docs: fix typos in documents (#690)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: 黄振鹏
Co-authored-by: ClarkXia
---
website/docs/guide/advanced/performance.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/docs/guide/advanced/performance.md b/website/docs/guide/advanced/performance.md
index 8a18889b..c8a38a84 100644
--- a/website/docs/guide/advanced/performance.md
+++ b/website/docs/guide/advanced/performance.md
@@ -40,7 +40,7 @@ start({
`prefetch` 值支持三种形式:
+ **布尔值**:当 `prefetch` 为 `true` 时,所以微应用资源均会被 `prefetch`;
-+ **数组**:当传入值为 `name` 的数组时,只要数组中的微应用资源会被 `prefetch`;
++ **数组**:当传入值为 `name` 的数组时,只有数组中的微应用资源会被 `prefetch`;
```js
start({