From 651adddaf0d80fe37b8f664e113a069f55da1d38 Mon Sep 17 00:00:00 2001
From: lrz <1414556676@qq.com>
Date: Tue, 26 May 2020 18:09:55 +0800
Subject: [PATCH] readme,docs
---
.gitignore | 3 +-
README.md | 236 +----------------------------
docs/.vuepress/config.js | 31 ++++
docs/.vuepress/public/img/logo.png | Bin 0 -> 6353 bytes
docs/README.md | 15 ++
docs/guide/README.md | 71 +++++++++
docs/guide/config.md | 232 ++++++++++++++++++++++++++++
docs/guide/feature.md | 11 ++
package.json | 7 +-
9 files changed, 369 insertions(+), 237 deletions(-)
create mode 100644 docs/.vuepress/config.js
create mode 100644 docs/.vuepress/public/img/logo.png
create mode 100644 docs/README.md
create mode 100644 docs/guide/README.md
create mode 100644 docs/guide/config.md
create mode 100644 docs/guide/feature.md
diff --git a/.gitignore b/.gitignore
index cdfa3cc..ab4b17f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
.DS_Store
node_modules
package-lock.json
-dist
\ No newline at end of file
+dist
+docs/.vuepress/dist
\ No newline at end of file
diff --git a/README.md b/README.md
index 25a4697..98eb56e 100644
--- a/README.md
+++ b/README.md
@@ -12,9 +12,9 @@ Luckysheet ，一款纯前端类似excel的在线表格，功能强大、配置
## Documentation - 文档
-[在线demo](https://luckysheet.office2.cn/examples/) coming soon!
+[在线demo](https://mengshukeji.github.io/LuckysheetDemo/)
-[在线文档](https://luckysheet.office2.cn/docs/) coming soon!
+[在线文档](https://mengshukeji.github.io/LuckysheetDocs/)
## Requirements - 环境
[Node.js](https://nodejs.org/en/) Version >= 6
@@ -67,238 +67,6 @@ npm run build后dist文件夹下的所有文件复制到项目目录
})
```
-## Basic Configuration - 基本配置项
-
-### container
-- 类型：String
-- 默认值："jfgrid"
-- 作用：容器的ID
-
-------------
-### title
-- 类型：String
-- 默认值："Luckysheet Demo"
-- 作用：表格的名称
-
-------------
-### column
-- 类型：Number
-- 默认值：60
-- 作用：空表格默认的列数量
-
-------------
-### row
-- 类型：Number
-- 默认值：84
-- 作用：空表格默认的行数据量
-
-------------
-### data
-- 类型：Array
-- 默认值：[{ "name": "Sheet1", color: "", "status": "1", "order": "0", "data": [], "config": {}, "index":0 }, { "name": "Sheet2", color: "", "status": "0", "order": "1", "data": [], "config": {}, "index":1 }, { "name": "Sheet3", color: "", "status": "0", "order": "2", "data": [], "config": {}, "index":2 }]
-- 作用：客户端sheet数据[shee1, sheet2, sheet3]
-
-------------
-
-### fullscreenmode
-- 类型：Boolean
-- 默认值：true
-- 作用：是否全屏模式，非全屏模式下，标记框不会强制选中。
-
-------------
-### autoFormatw
-- 类型：Boolean
-- 默认值：false
-- 作用：自动格式化超过4位数的数字为 亿万格式 例：true or "true" or "TRUE"
-
-------------
-### accuracy
-- 类型：Number
-- 默认值：undefined
-- 作用：设置传输来的数值的精确位数，小数点后n位 传参数为数字或数字字符串，例： "0" 或 0
-
-------------
-### allowCopy
-- 类型：Boolean
-- 默认值：true
-- 作用：是否允许拷贝
-
-------------
-### showtoolbar
-- 类型：Boolean
-- 默认值：true
-- 作用：是否第二列显示工具栏
-
-------------
-### showinfobar
-- 类型：Boolean
-- 默认值：true
-- 作用：是否显示顶部名称栏
-
-------------
-### showsheetbar
-- 类型：Boolean
-- 默认值：true
-- 作用：是否显示底部表格名称区域
-
-------------
-
-### showstatisticBar
-- 类型：Boolean
-- 默认值：true
-- 作用：是否显示底部计数栏
-
-------------
-### editMode
-- 类型：Boolean
-- 默认值：false
-- 作用：是否为编辑模式
-
-------------
-### allowEdit
-- 类型：Boolean
-- 默认值：true
-- 作用：是否允许前台编辑
-
-------------
-### enableAddRow
-- 类型：Boolean
-- 默认值：true
-- 作用：允许增加行
-
-------------
-### enableAddCol
-- 类型：Boolean
-- 默认值：true
-- 作用：允许增加列
-
-------------
-### pointEdit
-- 类型：Boolean
-- 默认值：false
-- 作用：是否是编辑器插入表格模式
-
-------------
-### pointEditUpdate
-- 类型：Function
-- 默认值：null
-- 作用：编辑器表格更新函数
-
-------------
-### pointEditZoom
-- 类型：Number
-- 默认值：1
-- 作用：编辑器表格编辑时缩放比例
-
-------------
-### pointEditZoom
-- 类型：Number
-- 默认值：1
-- 作用：编辑器表格编辑时缩放比例
-
-------------
-### userInfo
-- 类型：String
-- 默认值：`' rabbit'`
-- 作用：右上角的用户信息展示样式
-
-------------
-### userMenuItem
-- 类型：Array
-- 默认值：`[{url:"www.baidu.com", "icon":'', "name":"我的表格"}, {url:"www.baidu.com", "icon":'', "name":"退出登陆"}]`
-- 作用：点击右上角的用户信息弹出的菜单
-
-------------
-### myFolderUrl
-- 类型：String
-- 默认值："www.baidu.com"
-- 作用：左上角<返回按钮的链接
-
-------------
-### config
-- 类型：Object
-- 默认值：{}
-- 作用：表格行高、列宽、合并单元格、公式等设置
-
-------------
-### devicePixelRatio
-- 类型：Number
-- 默认值：window.devicePixelRatio
-- 作用：设备比例，比例越大表格分标率越高
-
-------------
-### gridKey
-- 类型：String
-- 默认值：""
-- 作用：表格唯一标识符
-
-------------
-### loadUrl
-- 类型：String
-- 默认值：""
-- 作用：配置loadUrl的地址，luckysheet会通过ajax请求表格数据，默认载入status为1的sheet数据中的所有data，其余的sheet载入除data字段外的所有字段
-
-------------
-### loadSheetUrl
-- 类型：String
-- 默认值：""
-- 作用：配置loadSheetUrl的地址，参数为gridKey（表格主键） 和 index（sheet主键合集，格式为[1,2,3]），返回的数据为sheet的data字段数据集合
-
-------------
-### updateUrl
-- 类型：String
-- 默认值：""
-- 作用：表格数据的更新地址
-
-------------
-### updateImageUrl
-- 类型：String
-- 默认值：""
-- 作用：缩略图的更新地址
-
-------------
-### allowUpdate
-- 类型：Boolean
-- 默认值：false
-- 作用：是否允许编辑后的后台更新
-
-------------
-### functionButton
-- 类型：String
-- 默认值：""
-- 作用：右上角功能按钮，例如`' '`
-
-------------
-### showConfigWindowResize
-- 类型：Boolean
-- 默认值：true
-- 作用：图表和数据透视表的配置会在右侧弹出，设置弹出后表格是否会自动缩进
-
-------------
-### enablePage
-- 类型：Boolean
-- 默认值：false
-- 作用：允许加载下一页
-
-------------
-### chartConfigChange
-- 类型：Function
-- 默认值：null
-- 作用：图表插件中图表更新触发的自定义方法
-
-------------
-### beforeCreateDom
-- 类型：Function
-- 默认值：null
-- 作用：表格创建之前自定义方法
-
-------------
-### fireMousedown
-- 类型：Function
-- 默认值：null
-- 作用：单元格数据下钻自定义方法
-
-------------
## Contact - 联系
mengshu@office2.cn
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
new file mode 100644
index 0000000..c229799
--- /dev/null
+++ b/docs/.vuepress/config.js
@@ -0,0 +1,31 @@
+module.exports = {
+ title: 'Luckysheet文档',
+ description: 'Luckysheet 配置文档/API/教程',
+ base: '/LuckysheetDocs/',
+ themeConfig: {
+ logo: '/img/logo.png',
+ // 页面滚动
+ smoothScroll: true,
+ // 导航栏
+ nav: [
+ { text: '首页', link: '/' },
+ { text: '指南', link: '/guide/' },
+ { text: '演示', link: 'https://mengshukeji.github.io/LuckysheetDemo/' },
+ { text: 'Github', link: 'https://github.com/mengshukeji/Luckysheet' },
+ ],
+ // 侧边栏
+ sidebar: {
+ '/guide/': [
+ '',
+ 'config',
+ 'feature'
+ ],
+ },
+ // 仓库地址
+ repo: 'mengshukeji/Luckysheet',
+ // 仓库链接文字
+ repoLabel: '在 GitHub 上编辑此页',
+ // 仓库的文档目录
+ docsDir: 'docs',
+ },
+}
\ No newline at end of file
diff --git a/docs/.vuepress/public/img/logo.png b/docs/.vuepress/public/img/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..4f0a5e9a0f8cd3f2361de3bcc4fcfa313d118fd4
GIT binary patch
literal 6353
zcma)>cT^MK^Y=H!1PBDAmqbEGnlvF4As}7pRY0nufb?nr2_2CVq$(XLB2ADY9qFh@
zFM@OtkS+ou?H51azn^oSKX&(h&fcA!x#!$FGq3wpPe+}Kf|UXQ04hxl6$8?<@83lR
zBi+l*DzX89IbBml$;jVoD~l=_Wt`G`QO`>^L|p&LvCtdIV5S#B2xp*^7Q01Ez=Y=K
zm&Fjf?8(
zXb-5%>V`qWfFSAxs<&^EcMro3cvJ4;OqzF{YN!HfRoJ1+?RYApZ-bu=S?)OVHy;Qi
z`)`#or+4HUg|bYybD-`jW1*_^)yO{>=j(4bV9C4@Y4^?5>wxujIb^C255cSU4P7F3
z*Ard`4rIt&VnusZL!vjb5W89gt5U=Chg~66=-lh>6kf(6_aVe;KQS`tH!+EA&mfo4
zQxv@lkIJOh;avw6!0vi<#4}6Okk3NB`{qq`x?(ocU;#44k#ZyNC0r14sN9`mb*Iz?
z54yU8WgRrYT?HbXB@Hix)ZNjOK)q;jh{d_^z5fR<@*FgoAEvzbw$|^VE
zK}@+TZzHeVG#!?pH|i)D4%zV2`Ov;Fqf|plaN+N^?x;%8rN&gWffiUIV*(UW0p)pS
zw7i1IvfstF(Vf==9I|sfX2jNk@3Ps^9#7g5Js!TBi@t0|t9KkmaZI$DcT0-byj^+db9-)^iZZR{D3j)*q@8
zVp(p!Tax9<#sPO`K@($eok}fzBlyZdiPZ!%M6{mR2neJCTo&kY
z#{rjdP#Tbm8?uilHCwm5;JHL}rjog1t9peo=@qB$OA{vyfeceFInOmIKoW_3+Je_<
za8RPj%bi4L29oGYDoSA`!+
z?&HinS?Sq5!r-NS?si!kvJ2I+Ei@NX_8bfXxWGfvxx3cp&unbajeIVeZXad7l-UyA
zk0U^TnF;GMbrSs}QlLP(%>2MyNzF9%9vu`>>*5Ys=rJa9q_5F)hH3eV*@Qr{Y-`dC
z>!^`gJ|Ve96%#&hM(nJC{K{h=jo+5DvLpO9O8bys7*~?78u0auVVtqNRqQ?=Sfjg%
zEH;D9Q0du`@*jS!Lne!F5#K*bBmb@J1-AbCLWxI0;zGPUx6o(O--SIk1qkBF%2$CV{
zz}v*#NL?8E6<$>ljA&;Ud*P5|e-N@pnM`ryykZL_X16Ze+-V#8si)E}O9OT5==c&9
z=WQVNYwIyr2{U#6NeP0B&<9akUN-f^8B){Co=-wP(D|$;o<~l$S5+DnIYMb5O36=S
zaD$)@UH$3@8&7-n8s?-ynRIeGFCn4>N`8w`_C*hEToavyhdDyP=$foMXceS=KLw}btyxCaQi{Wc9yOg
zo*l0O2Q|v}s@~p@MGsCS&6cIQ{|z{E-&E!T79af?=DhQBE{|m(e(q-;*_yQQ!UV*9
zlkO6ck$F8WnVE?wYW8&ll9%qaQ4wZ;?J~|&;o~*IK`6%62ZEFEbU`m$de77&Fb!8$
zg6JQ>h?&>WOL6Wo5-EnApYICkJ_+N`a?NdrVroB?p{^;cEHBcJmnuSuFr9B|KKChz
zqSlka;Dt$PfrH53ul7&vbva)E+<~&F6`M?Y)hiYmb*Hz%;*^>PJ0R!l?I*p5ZyG?Y
zks&tZson~OS!%ohC_5~IWvx26Txb(k8Lh}+dDEL{;HuM+qsf_^#l&G6>AwaSrtpd#f@eEm_`LY)gjHf6URn!1KM}KqU(}9l
z8y|T|LyqCK{49h4?&K(yEK>+GeVlWm5g8u&8N)1{JCj|^Q~BE(f>bCeyv{?5yDjsg
zUqYk&55}L5(f5h&x(c-}F5`lRSzVx37Tl4VnTkqff+UjEvmOW+v|po2-T
zx>Hx+HT9$)NTejf{_1OR@xsII*Z$HWdkN;|qn!WDzJPJpgd8h-Gr8%@8Z4S(cDLc<
z$4;XA4rYfIdijc1PXtV_0s8x`%Nzv$C=CnZV;run_lY;9$d+Ckr}^G0;TS&sV^g?n
ztI#{GdTaGBb=R{~{`N`(rzBc3%#X|g1x#mgqTB-g{HqnMuNKITscZeQlwI!`XAk*m
zmYT-hz+>NLNn3n*-U#gqgt&V|=J(3TJ4Ll}=}dGXih66VY-|Ebo!cTxx4*7h*lOU@
zZe;TFIU~t5>I*eSGF%E3@d=?TFk9kZ93po3L?a-SMn}E>JW>3|!FeKc$Fhy9p;OZT
zhEriWQ+M&$?mOn&@6U@tCi0I8oEPZFnsy@4jpG3ze1^%q<})ab7jhLrw6#v{tQyy?
za9i?i9%@4_=vy@vP+@bI?*+!fl3knT9sp}+YWgq<3=NJl{k@zD5(JulD9cDchF}e7
zHndsX4r*jsFcPZS(U)x*$%*99nY>~Ej`p0YxzqrK`lI55YEsE7F0K+T)(g!WS#=h3
z4yFSVKv=C?GyM9`34t$;dgGapaOx}HUVGXdNFXhSjlY@u#b$zO|9a4&PV5TBRz2B@
zPBwte<1No?QVcph=Bx&FJ}rZgp@8R=ln#2N6=tlv9TgIW2fZ9mE|l;nw>45iokwl{
z=woO8D25@Z?%+(7&TNKeW!RW0I6yi8W>8%
z6~$4r92ojEz@UF1D2p9~_JcI4gjB=VXQi^1JIAorql%9|3WKFDX|M)ct9sedUq55Y
z>|m==UO^Fu!fHv&xOBkgjia{-JYexbMd#q%;(bw2pZJxi`11$t+Lq!;ubTodXD+2B
z->m^Ki-i+W!^VH!j8LMLDla&ofu->^j;wS9qh@htykJ^}$-~U}_23YjM$i5CsX%!9
zROL{}qx$x+2*vN);B*Aoiylyyd
z2|OZTE$r|FHrrk0*W!2;*YR{(>fFa{SL>{tuTx6!;!hg$^udhU;C|!DGla(D)#2Pc
z^^I*sIjZ`ODrz=~*;EMBpDaE|xj@Xj1rE9$H&*mw={+G__tQz>K}OO**|5fZ4NS+j
z0uUbw;cp5!`Y&;-^}NzoS_0GlSpS*lQR%V`#xEaaz*w
z5tumrx758Br;wW7{77EX?=>kZGIrJebGy4<^-Fi5Jp(?qF5X;p1WId%>)vUnutt@(
zD8r!>s44>F2}fDD*+&gWemrO;&uw56U%Sm^NC*##*r);r%1PhSiN@;-tnDOBa1tnU
zFJ3_0$CK~M?mHU|j0`Lfi^&AC&R-GK8Hv*-g(ll9@~MpxH1}e-c;iZYLP%L@ZJq0M
zK%hC8W;Tw=o7Xj&irssOCr^y3?-nm*8~Elp7wG40PM>A5-eE&?YhJeUG^A2eHd_QSA7O(xyd!&IXRiM$-uu)x^K3P{F*3#;$*f;?_*ti<_1JL
zce~bT0Aj2Dt)NA^1$uUaM&mj`t5kXdR0gR?PCN?BVdJAEVHQPKwape>3of95eZ$>Y$a?cyE$$9IAn&oeecu
zR4$jQ@DnCF!p3d^Z7BKuAXV9eq)==r}AwIZ5
z%(G!+^r?C)rU2j&<;x|d`Ufkq+zIr>SnTG0EsBcS=FaBRUJ1=Pvyaz=(7
zJJH`?u;!raDw@E^MizlEXFf9EZOxbUpLt682#D*Uw!4n{}tcVVtTsYep-ufiW&PtPwLLWKPohW
z9;nLGG$U`xjt59SfYVq}75kT@UQ{qC^iMRMl`^>B9;U?}`k32(`?(6dEG~@W5(jB?
z=Rh0|j?l~BzkaK;4zmx|d!ft=aGZiqw(x8}&}HXTW?&uf|aR)%j&1E%J2XjX6xMe3&
zZF~*0XJP}Q+o%>MCCh}?A5y~C{M;#gMEbs=>kfaJS|g@Tg|UZI0m2y#U2hb?di$w<
z_3auz)A}+N=@Z5$6Y{-VcDMS<a^1#g!n&1`BhG1TPy|xEQcXrmKuo3&o>ujKc
z=Cin5j|4$EI;CI8-39%%?3!*3^-kxvW)~K$YO*eRG_!I+Y5=*jXUoNu^T`*O@zvQ_
zcN;pCoTZ2J_G|x7ABF{ZUIpH3?E%OkX)R4&Hg=7XM$&9OH`eNO$5SQ?H@+%Rjh!><
ziBhQq>zl@^N!!g)R!fD>NOwFg#4CoVfJ%PnTtdEVyJqwX&OvpS=p&_t{u%UPgy@{=
zDT;@cWT`TS?{*6zJ_!G|hF~D^
zK;Cslgp#QBwkyj^pT${$Pv$&|eN@LK6iI6=_jbO_{*1tE*oo>Iu5bs>M?qAMLc#|5
zer4XIWSARHdK!vU
z-PS1&?4l(hkHF90!{7XaAmK$O3LXEDhk}ErvhhC%qHHM0Zu<{;uuI6~36LNNcV0{S=0m3yt}+tx_-@b3XB0sa+>*7wE}M|p
z$1kxYx;M%sLHpADm`spFV2;!K$&EQkf?T^iF#I2Z`Tuu^*b?jFCda(bch134%JYa3
z9Zf~H^Len<3^dr&v84MB8~@x(8To$B4M4GS{Y@o-u0xYBcg9AthW=Ck`^X
zlNtJfqor~&KKpmVC@6YHn)LleSN-dp*%V0nD?+jW2optp4ZCq$me^B;Z7RRywKFk4DPU*dn0
z5M3p7e;h_p8bQ{EnNhole}2YgFUF(y7iHG?SbnqLkY)h_Fuu4&Y^5sR-Tn=Dwghv-
z9!n7Re#D^S$EZ8PBJH)_OJdvo8F1>rw``m&VsUEaH$ZD*R`KML$||2;SvWmBA1ew)
zxGANb*);wGx^$@rv-~O1CMeMzpgh#@y?ktj2+m1y!VSJ_wXb?h#RK;V#2yA2efuYu
z&wxV1M+&!5qjfnEYcmb1RtPibWeDgf+M%R%F!`6v!K1ae#NQK*$RSp2L<84`?lnv&k@-&7
zRHMB}%7*M)hWMbV)~uXaGwz_GOw1cx>HtE?V2Q=oh+%2+}By>OSt_TEjT(L~Hk%B6lA6nG&Qul?M&#Losn=mk9j`6K+lK|FG&
cnx-!x5= 6
+
+### 安装
+```shell
+npm install
+npm install gulp -g
+```
+
+### 开发
+```shell
+npm run dev
+```
+
+### 打包
+```shell
+npm run build
+```
+
+## 使用步骤
+
+### 第一步
+npm run build后dist文件夹下的所有文件复制到项目目录
+
+### 第二步
+引入依赖
+```html
+
+
+
+
+
+```
+### 第三步
+指定一个表格容器
+```html
+
+```
+### 第四步
+创建一个表格
+```javascript
+
+```
+
+
diff --git a/docs/guide/config.md b/docs/guide/config.md
new file mode 100644
index 0000000..9e2dc6a
--- /dev/null
+++ b/docs/guide/config.md
@@ -0,0 +1,232 @@
+# 基本配置
+
+## container
+- 类型：String
+- 默认值："jfgrid"
+- 作用：容器的ID
+
+------------
+## title
+- 类型：String
+- 默认值："Luckysheet Demo"
+- 作用：表格的名称
+
+------------
+## column
+- 类型：Number
+- 默认值：60
+- 作用：空表格默认的列数量
+
+------------
+## row
+- 类型：Number
+- 默认值：84
+- 作用：空表格默认的行数据量
+
+------------
+## data
+- 类型：Array
+- 默认值：[{ "name": "Sheet1", color: "", "status": "1", "order": "0", "data": [], "config": {}, "index":0 }, { "name": "Sheet2", color: "", "status": "0", "order": "1", "data": [], "config": {}, "index":1 }, { "name": "Sheet3", color: "", "status": "0", "order": "2", "data": [], "config": {}, "index":2 }]
+- 作用：客户端sheet数据[shee1, sheet2, sheet3]
+
+------------
+
+## fullscreenmode
+- 类型：Boolean
+- 默认值：true
+- 作用：是否全屏模式，非全屏模式下，标记框不会强制选中。
+
+------------
+## autoFormatw
+- 类型：Boolean
+- 默认值：false
+- 作用：自动格式化超过4位数的数字为 亿万格式 例：true or "true" or "TRUE"
+
+------------
+## accuracy
+- 类型：Number
+- 默认值：undefined
+- 作用：设置传输来的数值的精确位数，小数点后n位 传参数为数字或数字字符串，例： "0" 或 0
+
+------------
+## allowCopy
+- 类型：Boolean
+- 默认值：true
+- 作用：是否允许拷贝
+
+------------
+## showtoolbar
+- 类型：Boolean
+- 默认值：true
+- 作用：是否第二列显示工具栏
+
+------------
+## showinfobar
+- 类型：Boolean
+- 默认值：true
+- 作用：是否显示顶部名称栏
+
+------------
+## showsheetbar
+- 类型：Boolean
+- 默认值：true
+- 作用：是否显示底部表格名称区域
+
+------------
+
+## showstatisticBar
+- 类型：Boolean
+- 默认值：true
+- 作用：是否显示底部计数栏
+
+------------
+## editMode
+- 类型：Boolean
+- 默认值：false
+- 作用：是否为编辑模式
+
+------------
+## allowEdit
+- 类型：Boolean
+- 默认值：true
+- 作用：是否允许前台编辑
+
+------------
+## enableAddRow
+- 类型：Boolean
+- 默认值：true
+- 作用：允许增加行
+
+------------
+## enableAddCol
+- 类型：Boolean
+- 默认值：true
+- 作用：允许增加列
+
+------------
+## pointEdit
+- 类型：Boolean
+- 默认值：false
+- 作用：是否是编辑器插入表格模式
+
+------------
+## pointEditUpdate
+- 类型：Function
+- 默认值：null
+- 作用：编辑器表格更新函数
+
+------------
+## pointEditZoom
+- 类型：Number
+- 默认值：1
+- 作用：编辑器表格编辑时缩放比例
+
+------------
+## pointEditZoom
+- 类型：Number
+- 默认值：1
+- 作用：编辑器表格编辑时缩放比例
+
+------------
+## userInfo
+- 类型：String
+- 默认值：`' rabbit'`
+- 作用：右上角的用户信息展示样式
+
+------------
+## userMenuItem
+- 类型：Array
+- 默认值：`[{url:"www.baidu.com", "icon":'', "name":"我的表格"}, {url:"www.baidu.com", "icon":'', "name":"退出登陆"}]`
+- 作用：点击右上角的用户信息弹出的菜单
+
+------------
+## myFolderUrl
+- 类型：String
+- 默认值："www.baidu.com"
+- 作用：左上角<返回按钮的链接
+
+------------
+## config
+- 类型：Object
+- 默认值：{}
+- 作用：表格行高、列宽、合并单元格、公式等设置
+
+------------
+## devicePixelRatio
+- 类型：Number
+- 默认值：window.devicePixelRatio
+- 作用：设备比例，比例越大表格分标率越高
+
+------------
+## gridKey
+- 类型：String
+- 默认值：""
+- 作用：表格唯一标识符
+
+------------
+## loadUrl
+- 类型：String
+- 默认值：""
+- 作用：配置loadUrl的地址，luckysheet会通过ajax请求表格数据，默认载入status为1的sheet数据中的所有data，其余的sheet载入除data字段外的所有字段
+
+------------
+## loadSheetUrl
+- 类型：String
+- 默认值：""
+- 作用：配置loadSheetUrl的地址，参数为gridKey（表格主键） 和 index（sheet主键合集，格式为[1,2,3]），返回的数据为sheet的data字段数据集合
+
+------------
+## updateUrl
+- 类型：String
+- 默认值：""
+- 作用：表格数据的更新地址
+
+------------
+## updateImageUrl
+- 类型：String
+- 默认值：""
+- 作用：缩略图的更新地址
+
+------------
+## allowUpdate
+- 类型：Boolean
+- 默认值：false
+- 作用：是否允许编辑后的后台更新
+
+------------
+## functionButton
+- 类型：String
+- 默认值：""
+- 作用：右上角功能按钮，例如`' '`
+
+------------
+## showConfigWindowResize
+- 类型：Boolean
+- 默认值：true
+- 作用：图表和数据透视表的配置会在右侧弹出，设置弹出后表格是否会自动缩进
+
+------------
+## enablePage
+- 类型：Boolean
+- 默认值：false
+- 作用：允许加载下一页
+
+------------
+## chartConfigChange
+- 类型：Function
+- 默认值：null
+- 作用：图表插件中图表更新触发的自定义方法
+
+------------
+## beforeCreateDom
+- 类型：Function
+- 默认值：null
+- 作用：表格创建之前自定义方法
+
+------------
+## fireMousedown
+- 类型：Function
+- 默认值：null
+- 作用：单元格数据下钻自定义方法
+
+------------
\ No newline at end of file
diff --git a/docs/guide/feature.md b/docs/guide/feature.md
new file mode 100644
index 0000000..d294170
--- /dev/null
+++ b/docs/guide/feature.md
@@ -0,0 +1,11 @@
+# 高级功能
+
+## TODO...
+### api
+### 创建表格
+### 删除表格
+### 释放表格
+### 复制单元格
+### 插入单元格
+### 删除单元格
+### 编辑器单元格
\ No newline at end of file
diff --git a/package.json b/package.json
index bd6647b..e35267a 100644
--- a/package.json
+++ b/package.json
@@ -11,12 +11,15 @@
"gulp-clean-css": "^4.3.0",
"gulp-if": "^3.0.0",
"gulp-uglify": "^3.0.2",
- "gulp-useref": "^4.0.1"
+ "gulp-useref": "^4.0.1",
+ "vuepress": "^1.5.0"
},
"dependencies": {},
"scripts": {
"build": "gulp build",
- "dev": "gulp dev"
+ "dev": "gulp dev",
+ "docs:dev": "vuepress dev docs",
+ "docs:build": "vuepress build docs"
},
"files": [
"dist"