完善入门文档及新增api文档

docs/README.md

@@ -1,17 +1,15 @@
-
 # BUI 官方文档 1.7.x
 
 <p>
 <a href="https://github.com/imouou/BUI-Guide/releases"><img src="https://img.shields.io/github/tag/imouou/BUI-Guide.svg"></a>
 <a href="https://github.com/imouou/BUI-Guide"><img src="https://img.shields.io/github/stars/imouou/BUI-Guide.svg?style=social&label=Star"></a>
 </p>
 
-### 简介 
-
-> BUI 是一个更快的UI开发框架，专注Webapp快速开发，完美嵌入各平台或打包，媲美APP体验。
+### 简介
 
+> BUI 是一个专注移动快速开发的跨平台 UI 框架，基于文件路径式的路由和组件加载，开箱零配置，简单上手，完美嵌入各平台或打包 APP，适合独立开发各种 Webapp，App，轻应用，小程序，公众号，聆客，钉钉……
 
-#### 特点优势 
+#### 特点优势
 
 - 开箱即用
 - 零配置路由
@@ -26,84 +24,80 @@
 - 模块化开发
 - 组件化开发
 - 数据驱动开发
-- DOM开发
-- jQuery开发
-- ES6开发
-- NPM模块
+- DOM 开发
+- jQuery 开发
+- ES6 开发
+- NPM 模块
 - less or sass
 - ...
 
-
-> BUI还提供[编辑器插件 BUI-Fast](https://github.com/imouou/BUI-Fast-Snippets/)，[buijs-cli工程构建工具](chapter1/installation)，开发速度嗖嗖嗖。
-
+> BUI 还提供[编辑器插件 BUI-Fast](https://github.com/imouou/BUI-Fast-Snippets/)，[buijs-cli 工程构建工具](chapter1/installation)，开发速度嗖嗖嗖。
 
 #### 适用场景 <!-- {docsify-ignore} -->
 
-* 中小型应用webapp开发;
-* 微信公众号开发;
-* 微信小程序内嵌webview开发;
-* 支付宝，钉钉，淘宝内嵌webview开发;
-* demo交互原型投标;
-
+- 中小型应用 webapp 开发;
+- 微信公众号开发;
+- 微信小程序内嵌 webview 开发;
+- 支付宝，钉钉，淘宝内嵌 webview 开发;
+- demo 交互原型投标;
 
 #### 第三方打包独立应用 <!-- {docsify-ignore} -->
+
 - Cordova
 - DCloud
 - APICloud
 - AppCan
 - ...
 
-?> 可以下载BUI安卓体验包，用不同平台打包以后的效果. <a href="http://www.easybui.com/downloads/" target="_target">进入下载中心</a>
+?> 可以下载 BUI 安卓体验包，用不同平台打包以后的效果. <a href="http://www.easybui.com/downloads/" target="_target">进入下载中心</a>
 
 #### 谁在使用 <!-- {docsify-ignore} -->
 
 移动、电信、地铁、政府、银行等行业。
 
+### 案例效果
 
-### 案例效果 
-?> 基于BUI制作的`高保真还原`App交互效果
+?> 基于 BUI 制作的`高保真还原`App 交互效果
 
-| <img src="static/images/case/163_low.gif" alt="" width="240px">             | <img src="static/images/case/qq_low.gif" alt="" width="240px">    | <img src="static/images/case/weixin_low.gif" alt="" width="240px">    |
-|:--------------------:|:---------------:|:---------------:|
-| 网易新闻: 耗时`半天`  |QQ: 耗时`1天`      | 微信: 耗时`2小时`      |
+| <img src="static/images/case/163_low.gif" alt="" width="240px"> | <img src="static/images/case/qq_low.gif" alt="" width="240px"> | <img src="static/images/case/weixin_low.gif" alt="" width="240px"> |
+| :-------------------------------------------------------------: | :------------------------------------------------------------: | :----------------------------------------------------------------: |
+|                      网易新闻: 耗时`半天`                       |                         QQ: 耗时`1天`                          |                         微信: 耗时`2小时`                          |
 
 !> 默认的案例及模板都是单页开发，对于理解模块有一定的帮助. 以上案例都可以在[官网的资源](http://www.easybui.com/resource/)找到
 
-**扫码体验Demo**
+**扫码体验 Demo**
 
 ![BUI Demo](http://www.easybui.com/static/images/qrcode.png)
 
 **下载安卓体验版**
 
-![BUI Demo](http://www.easybui.com/static/images/qrcode/bui_dcloud_qrcode.png) 
-
-基于Dcloud打包
-
-
+![BUI Demo](http://www.easybui.com/static/images/qrcode/bui_dcloud_qrcode.png)
 
+基于 Dcloud 打包
 
 ### 开发者约定
 
 #### 1. 问题反馈
-遇到问题，请先在文档中搜索，如果没有找到结果，请使用[issue反馈](https://github.com/imouou/BUI-Guide/issues)，问题反馈尽量配合截图或者使用场景说明，百分百回（拒绝Q群及QQ私聊等渠道的信息）。
+
+遇到问题，请先在文档中搜索，如果没有找到结果，请使用[issue 反馈](https://github.com/imouou/BUI-Guide/issues)，问题反馈尽量配合截图或者使用场景说明，百分百回（拒绝 Q 群及 QQ 私聊等渠道的信息）。
 
 #### 2. 版本更新
-> cdn beta版地址: 用于修复问题后快速发布,可以下载使用，不建议直接引入地址用于生产环境.
+
+> cdn beta 版地址: 用于修复问题后快速发布,可以下载使用，不建议直接引入地址用于生产环境.
 
 - https://cdn.jsdelivr.net/npm/buijs/lib/latest/bui.css
 - https://cdn.jsdelivr.net/npm/buijs/lib/latest/bui.js
 
 > 如果要指定版本 https://cdn.jsdelivr.net/npm/[email protected]/lib/latest/bui.js
 
-
 ### 文档下载 <!-- {docsify-ignore} -->
 
-[BUI文档](https://github.com/imouou/BUI-Guide/)
+[BUI 文档](https://github.com/imouou/BUI-Guide/)
 
 ### 在线阅读 <!-- {docsify-ignore} -->
 
-[BUI在线阅读](https://imouou.github.io/BUI-Guide/)
+[BUI 在线阅读](https://imouou.github.io/BUI-Guide/)
 
 ### 链接 <!-- {docsify-ignore} -->
 
-[BUI官网](http://www.easybui.com)
+[BUI 官网](http://www.easybui.com)

docs/api-1.4.8/api.js

@@ -0,0 +1,98 @@
+YUI.add("yuidoc-meta", function(Y) {
+   Y.YUIDoc = { meta: {
+    "classes": [
+        "bui.accordion",
+        "bui.actionsheet",
+        "bui.ajax",
+        "bui.alert",
+        "bui.animate",
+        "bui.array",
+        "bui.back",
+        "bui.btn",
+        "bui.checkVersion",
+        "bui.config",
+        "bui.confirm",
+        "bui.dialog",
+        "bui.download",
+        "bui.dropdown",
+        "bui.emitter",
+        "bui.file",
+        "bui.fileselect",
+        "bui.getPageParams",
+        "bui.guid",
+        "bui.hint",
+        "bui.init",
+        "bui.levelselect",
+        "bui.list",
+        "bui.listview",
+        "bui.load",
+        "bui.loader",
+        "bui.loading",
+        "bui.mask",
+        "bui.number",
+        "bui.pickerdate",
+        "bui.platform",
+        "bui.prompt",
+        "bui.pullrefresh",
+        "bui.rating",
+        "bui.ready",
+        "bui.refresh",
+        "bui.router",
+        "bui.run",
+        "bui.scroll",
+        "bui.searchbar",
+        "bui.select",
+        "bui.sidebar",
+        "bui.slide",
+        "bui.stepbar",
+        "bui.storage",
+        "bui.swipe",
+        "bui.timer",
+        "bui.toggle",
+        "bui.typeof",
+        "bui.unit",
+        "bui.upload",
+        "bui.viewport"
+    ],
+    "modules": [
+        "Animate",
+        "Core",
+        "Event",
+        "Method",
+        "Native",
+        "UI"
+    ],
+    "allModules": [
+        {
+            "displayName": "Animate",
+            "name": "Animate",
+            "description": "<h3>动画库</h3> \n<h5>动画控制器</h5>\n{{#crossLink \"bui.animate\"}}{{/crossLink}}: 常用的transform动画及属性动画 <br>\n<h5>动画切换器</h5>\n{{#crossLink \"bui.toggle\"}}{{/crossLink}}: animate.css的常用动画,切换显示 <br>"
+        },
+        {
+            "displayName": "Core",
+            "name": "Core",
+            "description": "核心"
+        },
+        {
+            "displayName": "Event",
+            "name": "Event",
+            "description": "<h3>全局事件: </h3> \n<p>依次加载顺序, 所有事件均在 dom 加载以后处理.</p>\n<p>pagebefore(dom准备完毕,但bui还未初始化) -  pageinit(dom准备完毕,bui初始化完成) - pageready(dom+原生能力都已经准备完毕) - onload(图片及资源都加载完毕以后触发)</p>"
+        },
+        {
+            "displayName": "Method",
+            "name": "Method",
+            "description": "<h3>常用方法库</h3> \n<h5>数组比对</h5>\n{{#crossLink \"bui.array\"}}{{/crossLink}}: 常用数组比对 <br>\n<h5>对象存储</h5>\n{{#crossLink \"bui.storage\"}}{{/crossLink}}: 常用于搜索历史记录, 可以存储普通数据也可以存储对象数据, 返回值必定是数组\n<h5>平台检测</h5>\n{{#crossLink \"bui.platform\"}}{{/crossLink}}: 属于什么系统跟浏览器的检测 <br>\n<h5>其它常用</h5>\n{{#crossLink \"bui.guid\"}}{{/crossLink}}: 生成唯一id <br>\n{{#crossLink \"bui.typeof\"}}{{/crossLink}}: 检测对象类型 <br>\n{{#crossLink \"bui.checkVersion\"}}{{/crossLink}}: 获取最新版本 <br>"
+        },
+        {
+            "displayName": "Native",
+            "name": "Native",
+            "description": "<h3>原生方法库</h3>"
+        },
+        {
+            "displayName": "UI",
+            "name": "UI",
+            "description": "<h3>UI控件库</h3>\n{{#crossLink \"bui.btn\"}}{{/crossLink}}: 绑定跳转,提交 <br>\n{{#crossLink \"bui.list\"}}{{/crossLink}}: 滚动加载,下拉刷新,快速版本 <br>\n{{#crossLink \"bui.searchbar\"}}{{/crossLink}}: 搜索 <br>\n{{#crossLink \"bui.scroll\"}}{{/crossLink}}: 滚动加载,下拉刷新控件 <br>\n{{#crossLink \"bui.pullrefresh\"}}{{/crossLink}}: 下拉刷新控件 <br>\n{{#crossLink \"bui.swipe\"}}{{/crossLink}}: 滑动控件 <br>\n{{#crossLink \"bui.sidebar\"}}{{/crossLink}}: 菜单侧滑 <br>\n{{#crossLink \"bui.listview\"}}{{/crossLink}}: 列表侧滑 <br>\n{{#crossLink \"bui.slide\"}}{{/crossLink}}: 滑动控件 <br>\n{{#crossLink \"bui.hint\"}}{{/crossLink}}: 自动消失的提醒 <br>\n{{#crossLink \"bui.alert\"}}{{/crossLink}}: 弹出提醒,可以支持调试Object <br>\n{{#crossLink \"bui.confirm\"}}{{/crossLink}}: 确认提醒 <br>\n{{#crossLink \"bui.accordion\"}}{{/crossLink}}: 折叠菜单 <br>\n{{#crossLink \"bui.dialog\"}}{{/crossLink}}: 弹出框 <br>\n{{#crossLink \"bui.stepbar\"}}{{/crossLink}}: 步骤条 <br>\n{{#crossLink \"bui.loading\"}}{{/crossLink}}: 加载进度 <br>\n{{#crossLink \"bui.mask\"}}{{/crossLink}}: 遮罩 <br>\n{{#crossLink \"bui.select\"}}{{/crossLink}}: 下拉选择菜单 <br>\n{{#crossLink \"bui.pickerdate\"}}{{/crossLink}}: 日期控件 <br>\n{{#crossLink \"bui.dropdown\"}}{{/crossLink}}: 下拉菜单 <br>\n{{#crossLink \"bui.actionsheet\"}}{{/crossLink}}: 上拉菜单 <br>\n{{#crossLink \"bui.number\"}}{{/crossLink}}: 数字增减条 <br>\n{{#crossLink \"bui.rating\"}}{{/crossLink}}: 评分 <br>\n{{#crossLink \"bui.actionsheet\"}}{{/crossLink}}: 上拉选择菜单 <br>"
+        }
+    ]
+} };
+});