chore: 文档完善、错别字更正

This commit is contained in:
streakingman 2022-10-11 21:42:47 +08:00
parent cc06bb14e3
commit 3fa7059272
9 changed files with 41 additions and 16 deletions

View File

@ -19,7 +19,7 @@
**声明:本项目仅供交流,禁止商用!否则后果自负。基于此项目的二创都是欢迎的,但非二创请不要删除原仓库地址
(啥都不改唯独删除来源我真的会谢 🙄️,请尊重他人劳动成果)**
![qrcode.png](qrcode.png)
<img src="qrcode.png" style="width: 250px;" alt="体验地址二维码">
## Feature
@ -34,21 +34,22 @@
开心就好 😄
![preview.png](preview.png)
![preview2.png](preview2.png)
<img src="preview1.png" style="width: 250px" alt="预览">
<img src="preview2.png" style="width: 250px" alt="预览">
<img src="preview3.png" style="width: 250px" alt="预览">
<img src="preview4.png" style="width: 250px" alt="预览">
<img src="preview5.png" style="width: 250px" alt="预览">
## Contribution
vite+react 实现,欢迎 star、issue、pr、fork尽量标注原仓库地址
切换主题参考 `src/themes` 下的代码,欢迎整活
## Related Repo
<a href="https://github.com/opendilab" target="_blank">opendilab</a> 的 AI 整活!移步
<a href="https://github.com/opendilab/DI-sheep" target="_blank">DI-sheep深度强化学习 + 羊了个羊</a>
<img style="width:360px" src="https://github.com/opendilab/DI-sheep/raw/master/ui/public/demo.gif" alt="" />
<img style="width:250px" src="https://github.com/opendilab/DI-sheep/raw/master/ui/public/demo.gif" alt="" />
## Todo List
@ -69,9 +70,29 @@ vite+react 实现,欢迎 star、issue、pr、fork尽量标注原仓库地
## 二次开发
项目的自定义主题功能设计到后台存储Bmob 懒人数据库),如果您只是简单的整活,可能并不需要相关的逻辑。
详细的二次开发说移步这里[DIY 指南](/diy/README.md)
项目的自定义主题功能涉及到后台存储Bmob 懒人数据库),如果您只是简单的整活,可能并不需要相关的逻辑。
详细的二次开发说明请移步这里[DIY 指南](/diy/README.md)
## License
[GNU GENERAL PUBLIC LICENSE Version 3](LICENSE.md)
## 资助
由于各种白嫖的静态资源托管、后台服务的免费额度都已用完,目前自费升级了相关套餐。
如果您喜欢这个项目,觉得本项目对你有帮助的话,可以扫描下方付款码请我喝杯咖啡 ☕️/分摊后台服务费用~ 😘
<div style="display: flex;justify-content: space-between">
<div>
<p style="text-align: center">¥ 1</p>
<img src="public/wxQrcode1.jpg" style="width: 200px" alt="收款码">
</div>
<div>
<p style="text-align: center">¥ 5</p>
<img src="public/wxQrcode5.jpg" style="width: 200px" alt="收款码">
</div>
<div>
<p style="text-align: center">¥ 8</p>
<img src="public/wxQrcode8.jpg" style="width: 200px" alt="收款码">
</div>
</div>

View File

@ -24,10 +24,11 @@ yarn install
## 素材配置
原项目的自定义后台使用了 Bmob 后台DIY 时并不需要相关的逻辑,您只需要改动 `diy` 文件下的文件: 图片以及音频素材复制到 `diy/public` 下, 并配置 `diy/diy.theme.json`
原项目的自定义主题功能使用了 Bmob 后台DIY 时并不需要相关的逻辑,您只需要改动 `diy` 文件下的文件:
图片以及音频素材复制到 `diy/public` 下, 并配置 `diy/diy.theme.json`
文件即可,配置格式见 `src/themes/interface.ts`
以下是配置字段的说明:
以下是`diy.theme.json`配置字段的说明:
- title 标题
- desc 描述
@ -67,9 +68,10 @@ yarn dev:diy
yarn build:diy
```
会在 `diy/diy-dist` 下,生成静态资源,直接将这些文件复制服务器上代理即可。如果嫌麻烦,推荐使用 [vercel](https://vercel.com/) 一键部署(每月免费 100G 流量), 将更改后的项目推到自己的
githubgitlabbitbucket 同样支持)仓库, 使用 github 账号登录 vercel 后导入该项目,构建模版选择 vite 构建命令更改为 `yarn build:diy`
输出地址改为 `diy/diy-dist` 即可 。
会在 `diy/diy-dist` 下生成静态资源,直接将这些文件复制服务器上做代理即可。如果嫌麻烦,推荐使用 [vercel](https://vercel.com/)
一键部署(每月免费 100G 流量), 将更改后的项目推到自己的 githubgitlabbitbucket 同样支持)仓库,
使用 github 账号登录 vercel 后导入该项目,构建模版选择 vite
构建命令更改为 `yarn build:diy` 输出地址改为 `diy/diy-dist` 即可 。见下图:
<img src="./vercel.png" alt="" style="width: 400px"/>
@ -77,7 +79,8 @@ githubgitlabbitbucket 同样支持)仓库, 使用 github 账号登录
## 其他
如果您想体验项目的完整功能,则需要注册一个 [Bmob](https://www.bmobapp.com/) 账号, 注册后新建应用(有一年的白嫖版,免费请求数虽然很客观,但并发数有限制,请根据自己的实际流量
如果您想体验项目的完整功能,则需要注册一个 [Bmob](https://www.bmobapp.com/) 账号,
注册后新建应用(有一年的白嫖版,免费请求数虽然很客观,但并发数有限制,请根据自己的实际流量
选择升级套餐,或者其他存储方案)
新建应用后,去到设置页面拷贝密钥和安全码到项目的 `.env` 文件中
@ -91,7 +94,7 @@ ps: 如果您的项目托管在公共仓库中,请注意保护密钥,本地
`config` 表用来存储自定义配置的 json 字符串,需要新增 `content`
`file` 表则是为了 vercel 流量,将一些默认文件转为 base64 编码存到了数据库中,需要添加三列
`file` 表则是为了节省 vercel 流量,将一些默认文件转为 base64 字符串存到了数据库中,需要添加三列
![img.png](database-file.png)
最后,开发和打包命令分别使用 `yarn dev``yarn build` 即可

Binary file not shown.

Before

Width:  |  Height:  |  Size: 212 KiB

BIN
preview1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 174 KiB

BIN
preview3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 217 KiB

BIN
preview4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

BIN
preview5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

View File

@ -228,7 +228,8 @@
.divider {
width: 100%;
height: 0;
border-bottom: 1px solid rgb(0 0 0 / 8%);
border-bottom: 1px solid currentcolor;
opacity: 0.6;
}
@keyframes gradient {