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路径:

  1. http 例如:http://s.tbcdn.cn/g/fi/bui/seed-min.js
  2. https 例如:https://s.tbcdn.cn/g/fi/bui/seed-min.js

具体的加载方式和需要引入的JS文件,可参看章节:BUI的安装以及加载

常见的错误汇总

使用过程中您可能会发现很多容易引起错误的地方,请提交issue列表,或者查看其它用户提交的的错误。

已知的文档问题

目前BUI还处于开发阶段在文档方面我们仍存在很多问题,所以我们正在不断努力地改进我们的文档,其中已知的问题:

  • API 中的代码示例不够充分,很多特性未提供示例。
  • Demo 的数量依然不足,很多控件的特性和容易出问题的配置项并未提供完整的示例代码。
  • BUI 网站对低版本的ie支持不足

反馈

您可以将问题提交到issue列表中,也可以去论坛:http://bbs.builive.com,QQ群:138692365 ,旺旺群:778141976 中与其他使用者交流探讨。

贡献代码和文档

BUI是一个出色的开源前端框架,但由于作者的时间和精力是有限的,希望大家能积极支持和参与到BUI控件新功能的开发和文档的完善。BUI使用了Github来进行管理代码,其中:BUI 控件库文档库都在上面

  1. API 文档库,您可以帮助我修改对应的模板,和完善代码的注释。
  2. BUI 应用库,您可以在对应的应用中添加业务场景,和改善交互体验。
  3. 指引文档,您可以提出您的建议,更希望能积极的参与进文档的编写过程中来。
  4. 贡献patches和 bug fixes,请在github上按照提交规则进行。

开始第一步

如果您已经阅读到这里,相信您已经对BUI有了一定的了解。恭喜您!您已经成为BUI的用户,接下来我们可以阅读Hello BUI!进入学习BUI的第一环节。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,185评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,652评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,524评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,339评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,387评论 6 391
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,287评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,130评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,985评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,420评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,617评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,779评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,477评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,088评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,716评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,857评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,876评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,700评论 2 354