📝[Docs]: rEADME修改

xiaopengand · Oct 7, 2021 · 7a29fff · 7a29fff
1 parent 128c5c3
commit 7a29fff
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -13,14 +13,18 @@
 
 # 使用到的技术
 
-前端：Vue + ElementUI  
-后端：Node  
+前端：Vue
+
+后端：Node，Express
+
 数据存储：Gitee Issues
 
 # 使用教程
 
 前端与后端都存在一个 `config` 的文件夹，里面是网站的 **配置文件**
 
+群内文件 `教程 - 记仇小本本部署教程.doxc` 可查看图文教程配置
+
 ## 后端配置
 
 后端需要配置 Gitee Open API，首先进入 `Gitee - 个人设置 - 私人令牌`，[点我进入](https://gitee.com/profile/personal_access_tokens)
@@ -32,43 +36,21 @@
 生成后将令牌填写到后端的 `./api/config/lovexhj.json` 中的 `access_token` 中，
 `owner` 填写自己的账号，repo 则是填写自己的仓库名称（仓库可设为私有），`password` 则是自己设置一个记仇上传的密码，部署即可；
 
-我使用的是宝塔面板中的 PM2管理器 进行 Node 项目的部署，部署后使用映射功能就可通过链接访问 API；
+我使用的是宝塔面板中的 PM2 管理器 进行 Node 项目的部署，部署后使用映射功能就可通过链接访问 API；
 
 ## 前端配置
 
-首先在 `./js/lovexhj.js` 中，找到 `ServerBase`，更改成自己后端映射的地址；
+在 `./config/config.js` 中，找到 `ServerBase`，更改成自己后端映射的地址；
 
-文案的文案内容都在 `./config/lovexhj.json` 进行配置；
+同时这里面包含了小本本的文案，可随意修改；
 
 修改完毕后直接丢到服务器一把梭即可；
 
 ## 注意事项
 
-+ 如果需要添加 ssl，前后端都需要添加上才能使用
-+ 前端填写接口地址时，地址不要添加最后面的 `/`，例如 `https://heng.nutssss.cn/` 必须改成 `https://heng.nutssss.cn`
-
-# 更新日志
-
-> 2021-5-24
-
-+ 修改了部分样式
-+ 修复了未加载数据之前不会显示 Vue 代码
-
-> 2021-5-21
-
-+ 新增身份选择功能，可在前端 config 进行配置
-+ 密码输入后可以直接上传文章无需再次点击
-+ 密码错误可再次重新输入
-+ 后端逻辑 bug 修复
-
-> 2021-5-20
-
-+ 新增懒加载功能，每次加载十条记仇
-+ 新增密码录入功能，只需要输入一次密码即可连续记仇
-+ 新增了阴影美化
-+ 修复了富文本菜单不能用问题
-+ 修复了加载页面一些显示问题
+-   如果需要添加 ssl，前后端都需要添加上才能使用
+-   前端填写接口地址时，地址不要添加最后面的 `/`，例如 `https://heng.nutssss.cn/` 必须改成 `https://heng.nutssss.cn`
 
-# QQ群讨论
+# QQ 群讨论
 
-[坚果小栈](https://jq.qq.com/?_wv=1027&k=Mh7ah6Dd)
+[坚果小栈](https://jq.qq.com/?_wv=1027&k=Mh7ah6Dd)
diff --git a/api/config/config.js b/api/config/config.js
@@ -1,9 +1,9 @@
 /*
  * @Author: N0ts
  * @Date: 2021-05-19 02:08:33
- * @LastEditTime: 2021-10-07 16:18:52
+ * @LastEditTime: 2021-10-07 16:43:54
  * @Description: 后端配置
- * @FilePath: \heng\api\config\lovexhj.js
+ * @FilePath: \heng\api\config\config.js
  * @Mail：[email protected]
  */
 

diff --git a/config/config.js b/config/config.js
@@ -1,7 +1,7 @@
 /*
  * @Author: N0ts
  * @Date: 2021-05-18 22:53:40
- * @LastEditTime: 2021-10-07 16:36:18
+ * @LastEditTime: 2021-10-07 16:43:51
  * @Description: 前端配置
  * @FilePath: \heng\config\config.js
  * @Mail：[email protected]
@@ -11,25 +11,43 @@ export default {
     lovexhj: {
         // 后端地址
         ServerBase: "",
+        // 页面刚加载文字
         loadingText: "正在打开小本本",
+        // 首页
         lovexhjHeader: {
+            // 首页标题
             title: "TQY 与 XHJ 的记仇本本",
+            // 本本标题
             bookTitle: "爱我的猪"
         },
+        // 目录页标题
         pageTitle: "目录",
+        // 目录页副标题
         pageSubTitle: "点击就可以查看啦",
+        // 当前页数 / 一次加载多少条数据
         pageloadNum: [1, 10],
+        // 没有记仇时提示文字
         pageNone: "这么清静？还不去记仇？",
+        // 切换按钮文字
         wdnmdTextButton: ["记个仇", "查看小本本"],
+        // 记仇标题提示文字
         wdnmdPlaceholder: "记仇也要来个标题吧！",
+        // 记仇内容提示文字
         editText: "这个仇我先记上！",
+        // 提交记仇按钮文字
         wdnmdSubmit: "记到小本本",
+        // 记仇成功提醒文字
         wdnmdOk: "小本本又多了一条记仇~",
+        // 未填写密码提示文字
         passwordTitle: "记仇也是需要密码的！",
+        // 密码录入成功后提示文字
         passwordSetOk: "现在可以记仇啦！",
+        // 谁发的
         identity: [
             {
+                // 名字
                 name: "佩琪",
+                // 颜色
                 color: "#e84393"
             },
             {

diff --git a/index.html b/index.html
@@ -1,3 +1,12 @@
+<!--
+ * @Author: N0ts
+ * @Date: 2021-05-11 19:32:17
+ * @LastEditTime: 2021-10-07 16:43:29
+ * @Description: 记仇小本本
+ * @FilePath: \heng\index.html
+ * @Mail：[email protected]
+-->
+
 <!DOCTYPE html>
 <html lang="zh-CN">
 

diff --git a/js/lovexhj.js b/js/lovexhj.js
@@ -68,6 +68,8 @@ new Vue({
         this.getLocalConfig();
         // 记仇获取
         this.getWdnmd();
+        // 富文本编辑器创建
+        this.createEditor();
     },
 
     /**