更新:README文档

This commit is contained in:
caojiezi2003 2024-09-09 14:50:22 +08:00
parent 40e77fef15
commit 445cfe69fc

View File

@ -32,7 +32,8 @@ StackEdit中文版
<hr /> <hr />
## 说明 ## 说明
本项目为本人clone修改自用如果你也喜欢请至原作者处获取及交流。
本项目为本人clone修改自用如果你也喜欢请至原作者处获取及交流。在此致谢原作者。
## 截图 ## 截图
@ -52,6 +53,7 @@ StackEdit中文版
![](./images/chatgpt.gif) ![](./images/chatgpt.gif)
## 相比国外开源版本的区别: ## 相比国外开源版本的区别:
- 修复了Github授权登录问题 - 修复了Github授权登录问题
- 支持了Gitee仓库2022-05-25 - 支持了Gitee仓库2022-05-25
- 支持了Gitea仓库2022-05-25 - 支持了Gitea仓库2022-05-25
@ -80,11 +82,13 @@ StackEdit中文版
- 主文档空间支持GitHub登录2023-10-19 - 主文档空间支持GitHub登录2023-10-19
## 国外开源版本弊端: ## 国外开源版本弊端:
- 作者已经不维护了或很少维护了 - 作者已经不维护了或很少维护了
- 不支持国内常用Gitee - 不支持国内常用Gitee
- 强依赖GoogleDrive而Google Drive在国内不能正常访问 - 强依赖GoogleDrive而Google Drive在国内不能正常访问
## 部署说明 ## 部署说明
> 建议docker-compose方式部署其他部署方式如遇到问题欢迎提issue。 > 建议docker-compose方式部署其他部署方式如遇到问题欢迎提issue。
docker官方仓库下载太慢可以使用阿里云的镜像仓库镜像仓库地址registry.cn-hangzhou.aliyuncs.com/mafgwo/stackedit:【版本号】 docker官方仓库下载太慢可以使用阿里云的镜像仓库镜像仓库地址registry.cn-hangzhou.aliyuncs.com/mafgwo/stackedit:【版本号】
@ -122,6 +126,7 @@ services:
``` ```
docker-compose方式的启动或停止命令 docker-compose方式的启动或停止命令
```bash ```bash
# 在 docker-compose.yml 文件目录下 启动命令 # 在 docker-compose.yml 文件目录下 启动命令
docker-compose up -d docker-compose up -d
@ -157,19 +162,18 @@ docker run -itd --name stackedit \
``` ```
## 如何创建三方平台应用 ## 如何创建三方平台应用
> 部署时如果需要支持Gitee或GitHub则需要自行到对应三方平台创建应用获取到应用ID和秘钥替换到以上的环境变量中再启动应用。 > 部署时如果需要支持Gitee或GitHub则需要自行到对应三方平台创建应用获取到应用ID和秘钥替换到以上的环境变量中再启动应用。
- Gitee的环境变量GITEE_CLIENT_ID、GITEE_CLIENT_SECRET**[如何创建Gitee应用](./docs/部署之Gitee应用创建.md)** - Gitee的环境变量GITEE_CLIENT_ID、GITEE_CLIENT_SECRET**[如何创建Gitee应用](./docs/部署之Gitee应用创建.md)**
- GitHub的环境变量GITHUB_CLIENT_ID、GITEE_CLIENT_SECRET**[如何创建GitHub应用](./docs/部署之GitHub应用创建.md)** - GitHub的环境变量GITHUB_CLIENT_ID、GITEE_CLIENT_SECRET**[如何创建GitHub应用](./docs/部署之GitHub应用创建.md)**
- Gitea可选择性配置环境变量未配置则在关联时前端指定有配置则仅允许配置的应用信息GITEA_CLIENT_ID、GITEA_CLIENT_SECRET、GITEA_URL**[如何创建Gitea应用](./docs/部署之Gitea应用创建.md)** - Gitea可选择性配置环境变量未配置则在关联时前端指定有配置则仅允许配置的应用信息GITEA_CLIENT_ID、GITEA_CLIENT_SECRET、GITEA_URL**[如何创建Gitea应用](./docs/部署之Gitea应用创建.md)**
- Gitlab可选择性配置环境变量未配置则在关联时前端指定有配置则仅允许配置的应用信息GITLAB_CLIENT_ID、GITLAB_CLIENT_SECRET、GITLAB_URL **如何创建Gitlab应用(待补充文档)** - Gitlab可选择性配置环境变量未配置则在关联时前端指定有配置则仅允许配置的应用信息GITLAB_CLIENT_ID、GITLAB_CLIENT_SECRET、GITLAB_URL **如何创建Gitlab应用(待补充文档)**
特别说明自建的Gitea、Gitlab要能接入stackedit必须支持跨域 特别说明自建的Gitea、Gitlab要能接入stackedit必须支持跨域
## 编译与运行 ## 编译与运行
> 编译运行的nodejs版本选择11.15.0版本 > 编译运行的nodejs版本选择11.15.0版本
```bash ```bash
@ -185,4 +189,3 @@ npm run build
# build for production and view the bundle analyzer report # build for production and view the bundle analyzer report
npm run build --report npm run build --report
``` ```