docs(update): readme

1.readme add LuckyResources and How to contribution 2.config.md add hook function
dream-num · Nov 10, 2020 · bbdfb09 · bbdfb09
1 parent 49201e0
commit bbdfb09
Show file tree

Hide file tree

Showing 10 changed files with 155 additions and 44 deletions.
diff --git a/README-zh.md b/README-zh.md
@@ -13,9 +13,9 @@
 > Luckysheet最近参加了“2020年度OSC中国开源项目评选”，为了支持Luckysheet更好的得到关注和发展，请大家帮忙投票: [https://www.oschina.net/p/luckysheet](https://www.oschina.net/p/luckysheet)。
 
 ## 相关链接
- | 源码   | 文档 | Demo | 插件Demo | 论坛 |
- | ------ | -------- | ------ | ------ | ------ |
- | [Github](https://github.com/mengshukeji/Luckysheet)| [在线文档](https://mengshukeji.github.io/LuckysheetDocs/zh/) | [在线Demo](https://mengshukeji.github.io/LuckysheetDemo) | [导入Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [中文论坛](https://support.qq.com/product/288322) |
+ | 源码   | 文档 | Demo | 插件Demo | 论坛 | 资源 |
+ | ------ | -------- | ------ | ------ | ------ | ------ |
+ | [Github](https://github.com/mengshukeji/Luckysheet)| [在线文档](https://mengshukeji.github.io/LuckysheetDocs/zh/) | [在线Demo](https://mengshukeji.github.io/LuckysheetDemo) | [导入Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [中文论坛](https://support.qq.com/product/288322) | [LuckyResources](https://github.com/mengshukeji/LuckyResources) |
  | [Gitee镜像](https://gitee.com/mengshukeji/Luckysheet)| [Gitee在线文档](https://mengshukeji.gitee.io/LuckysheetDocs/zh/) | [Gitee在线Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee导入Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Google Group](https://groups.google.com/g/luckysheet) |
 
 
@@ -35,7 +35,7 @@
 + **数据类型** 
 	+ **货币, 百分比, 数字, 日期** 
 	+ **Custom** (和excel保持一致，例如： `##,###0.00` , `$1,234.56$##,###0.00_);[Red]($##,###0.00)`, `_($* ##,###0.00_);_(...($* "-"_);_(@_)`, `08-05 PM 01:30MM-dd AM/PM hh:mm` )
-+ **单元格内多样式** (Alt+Enter单元格内换行、上标、下标、单元格内科定义每个文字的不同样式)
++ **单元格内多样式** (Alt+Enter单元格内换行、上标、下标、单元格内可定义每个文字的不同样式)
 
 ### 🧬单元格
 + **拖拽选取来修改单元格** (对选区进行操作，可以拖动四边来移动选区，也可以在右下角对选区进行下拉填充操作)
@@ -167,19 +167,11 @@ npm run build
 - [excelize](https://github.com/360EntSecGroup-Skylar/excelize)
 - [h5-Dooring](https://github.com/MrXujiang/h5-Dooring)
 
-## 加入共建
+## 贡献
 
 1. 任何疑问或者建议，欢迎提交[Issues](https://github.com/mengshukeji/Luckysheet/issues/new/choose)
-2. 如果您想为 Luckysheet 实现一个重要功能，需要先撰写 RFC 文档，按照Luckysheet的 [RFC](https://github.com/mengshukeji/Luckysheet-rfcs) 机制进行操作，在经过社区讨论完善后才可以进行代码的提交。
-3. 如果您对Luckysheet感兴趣，非常欢迎加入开发组，一起来完善这个插件（下方扫码添加小编微信备注：共建），有4类任务可以认领
-    - BUG修复
-    - 新功能添加
-    - 文档
-    - 推广
-
-    您将收获：
-    - Luckysheet官方readme文档贡献者链接
-    - 参与大型开源项目，技术和视野提升
+2. 详细了解：[如何参与贡献](https://github.com/mengshukeji/Luckysheet/issues/128)
+
 
 ## 交流
 

diff --git a/README.md b/README.md
@@ -16,9 +16,9 @@ English| [简体中文](./README-zh.md)
 🚀Luckysheet is an online spreadsheet like excel that is powerful, simple to configure, and completely open source.
 
 ## Links
- | Source Code   | Documentation | Demo | Plugins Demo | Forum |
- | ------ | -------- | ------ | ------ | ------ |
- | [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://mengshukeji.github.io/LuckysheetDocs/) | [Online Demo](https://mengshukeji.github.io/LuckysheetDemo) | [Import Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [Chinese Forum](https://support.qq.com/product/288322)  |
+ | Source Code   | Documentation | Demo | Plugins Demo | Forum | Resources |
+ | ------ | -------- | ------ | ------ | ------ | ------ |
+ | [Github](https://github.com/mengshukeji/Luckysheet)| [Online Documentation](https://mengshukeji.github.io/LuckysheetDocs/) | [Online Demo](https://mengshukeji.github.io/LuckysheetDemo) | [Import Excel Demo](https://mengshukeji.github.io/LuckyexcelDemo/) | [Chinese Forum](https://support.qq.com/product/288322)  | [LuckyResources](https://github.com/mengshukeji/LuckyResources) |
  | [Gitee Mirror](https://gitee.com/mengshukeji/Luckysheet)| [Gitee Online Documentation](https://mengshukeji.gitee.io/LuckysheetDocs/) | [Gitee Online Demo](https://mengshukeji.gitee.io/luckysheetdemo/) | [Gitee Import Excel Demo](https://mengshukeji.gitee.io/luckyexceldemo/) | [Google Group](https://groups.google.com/g/luckysheet) |
 
 ![Demo](/docs/.vuepress/public/img/LuckysheetDemo.gif)
@@ -168,19 +168,10 @@ Create a table
 - [excelize](https://github.com/360EntSecGroup-Skylar/excelize)
 - [h5-Dooring](https://github.com/MrXujiang/h5-Dooring)
 
-## Co-construction
+## Contribution
 
 1. Any questions or suggestions are welcome to submit [Issues](https://github.com/mengshukeji/Luckysheet/issues/new/choose)
-2. If you want to implement an important function for Luckysheet, you need to write an RFC document first, follow Luckysheet's [RFC](https://github.com/mengshukeji/Luckysheet-rfcs) mechanism to operate, and only after community discussion and improvement, you can submit the code.
-3. If you are interested in Luckysheet, you are very welcome to join the development team to improve this plugin together (Email: alexads@foxmail.com), there are 4 types of tasks that can be claimed
-    - BUG
-    - New features
-    - Documentation
-    - Popularize
-
-    You will gain:
-    - Luckysheet official readme document contributor link
-    - Participate in large open source projects, improve technology and vision
+2. Learn more:[How to contribute](https://github.com/mengshukeji/Luckysheet/issues/128)
 
 ## Communication
 

diff --git a/deploy.bat b/deploy.bat
@@ -7,6 +7,8 @@ git add .
 git commit -m 'deploy Luckysheet demo'
 git push -f origin master:gh-pages
 
+# ===============================================
+
 # deploy Docs
 npm run docs:build
 cd docs/.vuepress/dist
@@ -16,6 +18,8 @@ git add .
 git commit -m 'deploy Luckysheet docs'
 git push -f origin master:gh-pages
 
+# ===============================================
+
 # replease
 npm run build
 npm run release -- --release-as patch
@@ -29,3 +33,22 @@ npm run commit
 npm version patch
 git push -u origin master
 npm publish
+
+# ===============================================
+
+# test pull request: https://docs.github.com/cn/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally
+
+# 139 is ID, dev is branch name
+git fetch origin pull/139/head:dev
+git checkout dev
+# test code
+git push origin dev
+# create new PR ,merge dev to master
+
+# list all remote and local branchs
+git branch -a
+# delete remote branch
+git push origin --delete dev
+git checkout master
+# delete local branch
+git branch -d dev
diff --git a/docs/guide/config.md b/docs/guide/config.md
@@ -544,6 +544,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### cellEditBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Triggered after double-clicking the cell, that is, when double-clicking the cell to edit the content, this method is triggered first
@@ -553,10 +554,11 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 	- {Object} [v]: Cell object
 
 ------------
-### cellEditAfter
+### cellExitEditBefore
+(TODO)
 - Type: Function
 - Default: null
-- Usage: Triggered after double-clicking the cell, that is, when double-clicking the cell to edit the content, this method is finally triggered
+- Usage: Exit the cell editing state, which is triggered before saving the cell value
 - Parameter: 
 	- {Number} [r]: Row number of cell
 	- {Number} [c]: Column number of cell
@@ -730,12 +732,14 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 ## Worksheet
 
 ### sheetCreatekBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Triggered before the worksheet is created, the new worksheet also includes the new pivot table
 
 ------------
 ### sheetCreateAfter
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Triggered after the worksheet is created, the new worksheet also includes the new pivot table
@@ -744,6 +748,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetMoveBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Before the worksheet is moved
@@ -753,6 +758,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetMoveAfter
+(TODO)
 - Type: Function
 - Default: null
 - Usage: After the worksheet is moved
@@ -763,6 +769,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetDeleteBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Before the worksheet is deleted
@@ -771,6 +778,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetDeleteAfter
+(TODO)
 - Type: Function
 - Default: null
 - Usage: After the worksheet is deleted
@@ -779,6 +787,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetEditNameBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Before changing the name of the worksheet
@@ -788,6 +797,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetEditNameAfter
+(TODO)
 - Type: Function
 - Default: null
 - Usage: After changing the name of the worksheet
@@ -798,6 +808,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetEditColorBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Before changing the color of the worksheet
@@ -807,6 +818,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetEditColorAfter
+(TODO)
 - Type: Function
 - Default: null
 - Usage: After changing the color of the worksheet
@@ -817,6 +829,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetZoomBefore
+(TODO)
 - Type: Function
 - Default: null
 - Usage: Before worksheet zoom
@@ -826,6 +839,7 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 
 ------------
 ### sheetZoomAfter
+(TODO)
 - Type: Function
 - Default: null
 - Usage: After worksheet zoom
@@ -834,6 +848,42 @@ The hook functions are uniformly configured under ʻoptions.hook`, and configura
 	- {String} [oldZoom]: Before modification, the current worksheet zoom ratio
 	- {String} [newZoom]: After modification, the current worksheet zoom ratio
 
+------------
+### sheetActivateBefore
+(TODO)
+- Type: Function
+- Default: null
+- Usage：Before worksheet activate
+- Parameter：
+	- {Number} [i]: `index` of current worksheet
+
+------------
+### sheetActivateAfter
+(TODO)
+- Type: Function
+- Default: null
+- Usage：After worksheet activate
+- Parameter：
+	- {Number} [i]: `index` of current worksheet
+
+------------
+### sheetDeactivateBefore
+（TODO）
+- Type: Function
+- Default: null
+- Usage：Before the worksheet changes from active to inactive
+- Parameter：
+	- {Number} [i]: `index` of current worksheet
+
+------------
+### sheetDeactivateAfter
+（TODO）
+- Type: Function
+- Default: null
+- Usage：After the worksheet is changed from active to inactive
+- Parameter：
+	- {Number} [i]: `index` of current worksheet
+
 ------------
 
 ## Workbook

diff --git a/docs/guide/resource.md b/docs/guide/resource.md
@@ -8,14 +8,14 @@ If you have written or found an excellent tutorial and want to recommend it to u
 - [How Luckysheet initializes the data with merged cells](https://www.cnblogs.com/DuShuSir/p/13272397.html)[Pending translation]
 - [How Luckysheet saves the data in the table to the database](https://www.cnblogs.com/DuShuSir/p/13857874.html)[Pending translation]
 - [Case of introducing Luckysheet into local HTML using CDN loading](https://www.cnblogs.com/DuShuSir/p/13859103.html)[Pending translation]
+- [Basic usage of Luckysheet, use `loadUrl` to load server data](https://blog.csdn.net/DCDC2020/article/details/108486525)
 
-## Collaborative editing background
+## Back-end
 
 ### Community Case
 - [Luckysheet save and restore](https://gitee.com/ichiva/luckysheet-saved-in-recovery) (Java version)
 - [Online form for collaborative editing based on Luckysheet](https://github.com/DilemmaVi/ecsheet) (Java version)
 
-
 ## Learning Materials
 
 - [How to build a web data analysis report from 0 to 1](https://github.com/mengshukeji/LuckyResources/blob/master/ppt/%E5%A6%82%E4%BD%95%E4%BB%8E0%E5%88%B01%E6%90%AD%E5%BB%BA%20Web%20%E6%95%B0%E6%8D%AE%E5%88%86%E6%9E%90%E6%8A%A5%E8%A1%A8.pptx)[Pending translation]
diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md
@@ -18,7 +18,7 @@ Luckysheet ，一款纯前端类似excel的在线表格，功能强大、配置
 + **数据类型** 
 	+ **货币, 百分比, 数字, 日期** 
 	+ **Custom** (和excel保持一致，例如： `##,###0.00` , `$1,234.56$##,###0.00_);[Red]($##,###0.00)`, `_($* ##,###0.00_);_(...($* "-"_);_(@_)`, `08-05 PM 01:30MM-dd AM/PM hh:mm` )
-+ **单元格内多样式** (Alt+Enter单元格内换行、上标、下标、单元格内科定义每个文字的不同样式)
++ **单元格内多样式** (Alt+Enter单元格内换行、上标、下标、单元格内可定义每个文字的不同样式)
 
 ### 🧬单元格
 + **拖拽选取来修改单元格** (对选区进行操作，可以拖动四边来移动选区，也可以在右下角对选区进行下拉填充操作)