chore: Rename the website directory to docs

This commit is contained in:
vben
2024-08-01 21:05:31 +08:00
parent 4a7a4f97ee
commit 06ad5ad871
73 changed files with 154 additions and 374 deletions

153
docs/src/guide/other/faq.md Normal file
View File

@@ -0,0 +1,153 @@
# 常见问题 #{faq}
::: tip 列举了一些常见的问题
有问题可以先来这里寻找,如果没有可以在 [GitHub Issue](https://github.com/vbenjs/vue-vben-admin/issues) 搜索或者提交你的问题, 如果是讨论性的问题可以在 [GitHub Discussions](https://github.com/vbenjs/vue-vben-admin/discussions)
:::
## 说明
遇到问题,可以先从以下几个方面查找
1. 对应模块的 GitHub 仓库 [issue](https://github.com/vbenjs/vue-vben-admin/issues) 搜索
2. 从[google](https://www.google.com)搜索问题
3. 从[百度](https://www.baidu.com)搜索问题
4. 在下面列表找不到问题可以到 issue 提问 [issues](https://github.com/vbenjs/vue-vben-admin/issues)
5. 如果不是问题类型的,需要讨论的,请到 [discussions](https://github.com/vbenjs/vue-vben-admin/discussions) 讨论
## 依赖问题
`Monorepo` 项目下,需要养成每次 `git pull`代码都要执行`pnpm install`的习惯,因为经常会有新的依赖包加入,项目在`.husky/git-merge`已经配置了自动执行`pnpm install`,但是有时候会出现问题,如果没有自动执行,建议手动执行一次。
## 关于缓存更新问题
项目配置默认是缓存在 `localStorage` 内,所以版本更新后可能有些配置没改变。
解决方式是每次更新代码的时候修改 `package.json` 内的 `version` 版本号. 因为 localStorage 的 key 是根据版本号来的。所以更新后版本不同前面的配置会失效。重新登录即可
## 关于修改配置文件的问题
当修改 `.env` 等环境文件以及 `vite.config.ts` 文件时vite 会自动重启服务。
自动重启有几率出现问题,请重新运行项目即可解决.
## 本地运行报错
由于 vite 在本地没有转换代码,且代码中用到了可选链等比较新的语法。所以本地开发需要使用版本较高的浏览器(`Chrome 90+`)进行开发
## 页面切换后页面空白
这是由于开启了路由切换动画,且对应的页面组件存在多个根节点导致的,在页面最外层添加`<div></div>`即可
**错误示例**
```vue
<template>
<!-- 注释也算一个节点 -->
<h1>text h1</h1>
<h2>text h2</h2>
</template>
```
**正确示例**
```vue
<template>
<div>
<h1>text h1</h1>
<h2>text h2</h2>
</div>
</template>
```
::: tip 提示
- 如果想使用多个根标签,可以禁用路由切换动画
- template 下面的根注释节点也算一个节点
:::
## 我的代码本地开发可以,打包就不行了
目前发现这个原因可能有以下,可以从以下原因来排查,如果还有别的可能,欢迎补充
- 使用了 ctx 这个变量ctx 本身未暴露出在实例类型内Vue官方也是说了不要用这个属性。这个属性只是用于内部使用。
```ts
import { getCurrentInstance } from 'vue';
getCurrentInstance().ctx.xxxx;
```
## 依赖安装问题
- 如果依赖安装不了或者启动报错可以尝试执行`pnpm run resintall`
- 如果依赖安装不了或者报错,可以尝试切换手机热点来进行依赖安装。
- 如果还是不行,可以自行配置国内镜像安装。
- 也可以在项目根目录创建 `.npmrc` 文件,内容如下
```bash
# .npmrc
registry = https://registry.npmmirror.com/
```
## 打包文件过大
- 首先,完整版由于引用了比较多的库文件,所以打包会比较大。可以使用精简版来进行开发
- 其次建议开启 gzip使用之后体积会只有原先 1/3 左右。gzip 可以由服务器直接开启。如果是这样,前端不需要构建 `.gz` 格式的文件,如果前端构建了 `.gz` 文件,以 nginx 为例nginx 需要开启 `gzip_static: on` 这个选项。
- 开启 gzip 的同时还可以同时开启 `brotli`,比 gzip 更好的压缩。两者可以共存
**注意**
- gzip_static: 这个模块需要 nginx 另外安装,默认的 nginx 没有安装这个模块。
- 开启 `brotli` 也需要 nginx 另外安装模块
## 运行错误
如果出现类似以下错误,请检查项目全路径(包含所有父级路径)不能出现中文、日文、韩文。否则将会出现路径访问 404 导致以下问题
```ts
[vite] Failed to resolve module import "ant-design-vue/dist/antd.css-vben-adminode_modulesant-design-vuedistantd.css". (imported by /@/setup/ant-design-vue/index.ts)
```
## 控制台路由警告问题
如果看到控制台有如下警告,且页面**能正常打开** 可以忽略该警告。
后续 `vue-router` 可能会提供配置项来关闭警告
```ts
[Vue Router warn]: No match found for location with path "xxxx"
```
## 启动报错
当出现以下错误信息时,请检查你的 nodejs 版本号是否符合要求
```bash
TypeError: str.matchAll is not a function
at Object.extractor (vue-vben-admin-main\node_modules@purge-icons\core\dist\index.js:146:27)
at Extract (vue-vben-admin-main\node_modules@purge-icons\core\dist\index.js:173:54)
```
## nginx 部署
部署到 `nginx`后,可能会出现以下错误:
```bash
Failed to load module script: Expected a JavaScript module script but the server responded with a MIME type of "application/octet-stream". Strict MIME type checking is enforced for module scripts per HTML spec.
```
解决方式:
```bash
http {
types {
application/javascript js mjs;
}
}
```

View File

@@ -0,0 +1,55 @@
# 项目更新
## 为什么无法像 npm 插件一样更新
因为项目是一个完整的项目模版,不是一个插件或者安装包,无法像插件一样更新,你使用代码后,会根据业务需求,进行二次开发,需要自行手动合并升级。
## 我需要怎么做
项目采用了 `Monorepo` 的方式进行管理,并将一些比较核心的代码进行了抽离,比如 `packages/@core``packages/effects`,只要业务代码没有修改这部分代码,那么你可以直接拉取最新代码,然后合并到你的分支上,只需要简单的处理部分冲突即可。其余文件夹只会进行一些小的调整,不会对业务代码产生影响。
::: tip 推荐
建议关注仓库动态,积极去合并,不要长时间积累,否则将会导致合并冲突过多,增加合并难度。
:::
## 使用 Git 更新代码
1. 克隆代码
```bash
git clone https://github.com/vbenjs/vue-vben-admin.git
```
2. 添加自己的公司 git 源地址
```bash
# up 为源名称,可以随意设置
# gitUrl为开源最新代码
git remote add up gitUrl;
```
3. 提交代码到自己公司 git
```bash
# 提交代码到自己公司
# main为分支名 需要自行根据情况修改
git push up main
# 同步公司的代码
# main为分支名 需要自行根据情况修改
git pull up main
```
4. 如何同步开源最新代码
```bash
git pull origin main
```
::: tip 提示
同步代码的时候会出现冲突。只需要把冲突解决即可
:::

View File

@@ -0,0 +1,18 @@
# 移除代码
## 移除百度统计代码
在对应应用的 `index.html` 文件中,找到如下代码,删除即可:
```html
<!-- apps/web-antd -->
<script>
var _hmt = _hmt || [];
(function () {
var hm = document.createElement('script');
hm.src = 'https://hm.baidu.com/hm.js?d20a01273820422b6aa2ee41b6c9414d';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(hm, s);
})();
</script>
```