BUI入门系列-手册快速入门
声明:
原来旧有的builive(bui后台前端框架)很久不维护了,我把手册文档搞到线上,应急的可以临时用下: http://builive.baogaoban.com/
导引
欢迎使用BUI!在这一章节里,本章主要解决以下问题::
如何去学习使用BUI?
去哪里查找相关文档和API?
为什么需要搭建web服务器?
如何参与BUI和贡献自己的力量?
文档
BUI 网站提供了丰富的Demo和完善的API文档,在这个文档中心提供了BUI的入门、基础、控件、扩展四个分类,供初学者入门学习。
导引
在此,我们为开发者提供了详尽的章节介绍BUI,其中推荐开发者以文档结构的顺序进行深入学习BUI。对于“如何去学习使用BUI?”和初学者,您应该从Hello BUI!开始学习,如果您已经使用过BUI或者阅读过该章节,可以从后面的章节开始。
参考指南
本文档中心仅供初学者入门学习阅读,如需更深入了解BUI可查阅参考BUI的API文档。其中部分文档可能会在Github上进行修改并放出
查看API
BUI的API文档可在控件库 API中查阅,该API文档是由js-duck对代码中的注释进行生成的。当然用户也可以通过下载源码,修改源码中的注释生成自己的API文档
目前API的版本只有一个,暂时还未有新的版本发布,所有用户提出的问题都会得到积极的反馈,如有需要可以将问题提交到issue 列表中。如果未来我们提供新版本,会让用户方便的访问到各个版本的API并标示清楚。
常见问题
在本文档中心中您可以发现很多常见的问题,并且有完善的解决方案。通过阅读学习,可以快速解决常见的各类问题。
API过期警告
为了统一命名和使用的方便性,在API中您可能会看到deprecation
的警告,我们可能将会在未来更改其对应的方法名称或者移除该方法。
使用一个web服务器
在下载好BUI后,可能您会发现DEMO的部分功能无法实现或者出现错误,这是由于部分功能需要异步请求数据和部分的文档是.php文件。所以建议用户在本地搭建一个PHP服务器并把BUI的Demo添加到服务器上运行。
window 环境下可以使用IIS、XAMPP或者Easy PHP,具体搭建教程可查看其官方网站或自行网上搜索。
使用CDN
在使用BUI的过程中,如果您想替换本地资源使用更稳定快速的CDN服务,我们提供了http和https两种协议的CDN路径:
具体的加载方式和需要引入的JS文件,可参看章节:BUI的安装以及加载
常见的错误汇总
使用过程中您可能会发现很多容易引起错误的地方,请提交issue列表,或者查看其它用户提交的的错误。
已知的文档问题
目前BUI还处于开发阶段在文档方面我们仍存在很多问题,所以我们正在不断努力地改进我们的文档,其中已知的问题:
- API 中的代码示例不够充分,很多特性未提供示例。
- Demo 的数量依然不足,很多控件的特性和容易出问题的配置项并未提供完整的示例代码。
- BUI 网站对低版本的ie支持不足
反馈
您可以将问题提交到issue列表中,也可以去论坛:http://bbs.builive.com,QQ群:138692365 ,旺旺群:778141976 中与其他使用者交流探讨。
贡献代码和文档
BUI是一个出色的开源前端框架,但由于作者的时间和精力是有限的,希望大家能积极支持和参与到BUI控件新功能的开发和文档的完善。BUI使用了Github来进行管理代码,其中:BUI 控件库和文档库都在上面
- API 文档库,您可以帮助我修改对应的模板,和完善代码的注释。
- BUI 应用库,您可以在对应的应用中添加业务场景,和改善交互体验。
- 指引文档,您可以提出您的建议,更希望能积极的参与进文档的编写过程中来。
- 贡献patches和 bug fixes,请在github上按照提交规则进行。
开始第一步
如果您已经阅读到这里,相信您已经对BUI有了一定的了解。恭喜您!您已经成为BUI的用户,接下来我们可以阅读Hello BUI!进入学习BUI的第一环节。