From 445cfe69fc12527232e5ac3a1e30315ab5f60049 Mon Sep 17 00:00:00 2001 From: caojiezi2003 <249085952@qq.com> Date: Mon, 9 Sep 2024 14:50:22 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=EF=BC=9AREADME=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index be02a3fb..e3d07e83 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,8 @@ StackEdit中文版
## 说明 -本项目为本人clone修改自用，如果你也喜欢，请至原作者处获取及交流。 + +本项目为本人clone修改自用，如果你也喜欢，请至原作者处获取及交流。在此致谢原作者。 ## 截图 @@ -52,6 +53,7 @@ StackEdit中文版 ![](./images/chatgpt.gif) ## 相比国外开源版本的区别： + - 修复了Github授权登录问题 - 支持了Gitee仓库（2022-05-25） - 支持了Gitea仓库（2022-05-25） @@ -80,11 +82,13 @@ StackEdit中文版 - 主文档空间支持GitHub登录（2023-10-19） ## 国外开源版本弊端： + - 作者已经不维护了或很少维护了 - 不支持国内常用Gitee - 强依赖GoogleDrive，而Google Drive在国内不能正常访问 ## 部署说明 + > 建议docker-compose方式部署，其他部署方式如遇到问题欢迎提issue。 docker官方仓库下载太慢可以使用阿里云的镜像仓库，镜像仓库地址：registry.cn-hangzhou.aliyuncs.com/mafgwo/stackedit:【版本号】 @@ -122,6 +126,7 @@ services: ``` docker-compose方式的启动或停止命令 + ```bash # 在 docker-compose.yml 文件目录下 启动命令 docker-compose up -d @@ -157,19 +162,18 @@ docker run -itd --name stackedit \ ``` ## 如何创建三方平台应用 + > 部署时，如果需要支持Gitee或GitHub，则需要自行到对应三方平台创建应用，获取到应用ID和秘钥，替换到以上的环境变量中，再启动应用。 - Gitee的环境变量：GITEE_CLIENT_ID、GITEE_CLIENT_SECRET，**[如何创建Gitee应用](./docs/部署之Gitee应用创建.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)** - - Gitlab可选择性配置环境变量（未配置则在关联时前端指定，有配置则仅允许配置的应用信息）：GITLAB_CLIENT_ID、GITLAB_CLIENT_SECRET、GITLAB_URL **如何创建Gitlab应用(待补充文档)** （特别说明：自建的Gitea、Gitlab要能接入stackedit必须支持跨域） ## 编译与运行 + > 编译运行的nodejs版本选择11.15.0版本 ```bash @@ -185,4 +189,3 @@ npm run build # build for production and view the bundle analyzer report npm run build --report ``` -