聲明:
原來舊有的builive(bui后臺(tái)前端框架)很久不維護(hù)了,我把手冊(cè)文檔搞到線上倡勇,應(yīng)急的可以臨時(shí)用下: http://builive.baogaoban.com/
導(dǎo)引
歡迎使用BUI著觉!在這一章節(jié)里村生,本章主要解決以下問題::
如何去學(xué)習(xí)使用BUI?
去哪里查找相關(guān)文檔和API饼丘?
為什么需要搭建web服務(wù)器趁桃?
如何參與BUI和貢獻(xiàn)自己的力量?
文檔
BUI 網(wǎng)站提供了豐富的Demo和完善的API文檔肄鸽,在這個(gè)文檔中心提供了BUI的入門卫病、基礎(chǔ)、控件典徘、擴(kuò)展四個(gè)分類忽肛,供初學(xué)者入門學(xué)習(xí)。
導(dǎo)引
在此烂斋,我們?yōu)殚_發(fā)者提供了詳盡的章節(jié)介紹BUI屹逛,其中推薦開發(fā)者以文檔結(jié)構(gòu)的順序進(jìn)行深入學(xué)習(xí)BUI。對(duì)于“如何去學(xué)習(xí)使用BUI汛骂?”和初學(xué)者罕模,您應(yīng)該從Hello BUI!開始學(xué)習(xí),如果您已經(jīng)使用過BUI或者閱讀過該章節(jié)帘瞭,可以從后面的章節(jié)開始淑掌。
參考指南
本文檔中心僅供初學(xué)者入門學(xué)習(xí)閱讀,如需更深入了解BUI可查閱參考BUI的API文檔蝶念。其中部分文檔可能會(huì)在Github上進(jìn)行修改并放出
查看API
BUI的API文檔可在控件庫 API中查閱抛腕,該API文檔是由js-duck對(duì)代碼中的注釋進(jìn)行生成的芋绸。當(dāng)然用戶也可以通過下載源碼,修改源碼中的注釋生成自己的API文檔
目前API的版本只有一個(gè)担敌,暫時(shí)還未有新的版本發(fā)布摔敛,所有用戶提出的問題都會(huì)得到積極的反饋,如有需要可以將問題提交到issue 列表中全封。如果未來我們提供新版本马昙,會(huì)讓用戶方便的訪問到各個(gè)版本的API并標(biāo)示清楚。
常見問題
在本文檔中心中您可以發(fā)現(xiàn)很多常見的問題刹悴,并且有完善的解決方案行楞。通過閱讀學(xué)習(xí),可以快速解決常見的各類問題土匀。
API過期警告
為了統(tǒng)一命名和使用的方便性子房,在API中您可能會(huì)看到deprecation
的警告,我們可能將會(huì)在未來更改其對(duì)應(yīng)的方法名稱或者移除該方法就轧。
使用一個(gè)web服務(wù)器
在下載好BUI后池颈,可能您會(huì)發(fā)現(xiàn)DEMO的部分功能無法實(shí)現(xiàn)或者出現(xiàn)錯(cuò)誤,這是由于部分功能需要異步請(qǐng)求數(shù)據(jù)和部分的文檔是.php文件钓丰。所以建議用戶在本地搭建一個(gè)PHP服務(wù)器并把BUI的Demo添加到服務(wù)器上運(yùn)行躯砰。
window 環(huán)境下可以使用IIS、XAMPP或者Easy PHP,具體搭建教程可查看其官方網(wǎng)站或自行網(wǎng)上搜索携丁。
使用CDN
在使用BUI的過程中,如果您想替換本地資源使用更穩(wěn)定快速的CDN服務(wù)琢歇,我們提供了http和https兩種協(xié)議的CDN路徑:
具體的加載方式和需要引入的JS文件,可參看章節(jié):BUI的安裝以及加載
常見的錯(cuò)誤匯總
使用過程中您可能會(huì)發(fā)現(xiàn)很多容易引起錯(cuò)誤的地方梦鉴,請(qǐng)?zhí)峤?a target="_blank">issue列表李茫,或者查看其它用戶提交的的錯(cuò)誤。
已知的文檔問題
目前BUI還處于開發(fā)階段在文檔方面我們?nèi)源嬖诤芏鄦栴}肥橙,所以我們正在不斷努力地改進(jìn)我們的文檔魄宏,其中已知的問題:
- API 中的代碼示例不夠充分,很多特性未提供示例存筏。
- Demo 的數(shù)量依然不足宠互,很多控件的特性和容易出問題的配置項(xiàng)并未提供完整的示例代碼。
- BUI 網(wǎng)站對(duì)低版本的ie支持不足
反饋
您可以將問題提交到issue列表中,也可以去論壇:http://bbs.builive.com椭坚,QQ群:138692365 ,旺旺群:778141976 中與其他使用者交流探討予跌。
貢獻(xiàn)代碼和文檔
BUI是一個(gè)出色的開源前端框架,但由于作者的時(shí)間和精力是有限的善茎,希望大家能積極支持和參與到BUI控件新功能的開發(fā)和文檔的完善券册。BUI使用了Github來進(jìn)行管理代碼,其中:BUI 控件庫和文檔庫都在上面
- API 文檔庫,您可以幫助我修改對(duì)應(yīng)的模板烁焙,和完善代碼的注釋航邢。
- BUI 應(yīng)用庫,您可以在對(duì)應(yīng)的應(yīng)用中添加業(yè)務(wù)場(chǎng)景骄蝇,和改善交互體驗(yàn)膳殷。
- 指引文檔,您可以提出您的建議乞榨,更希望能積極的參與進(jìn)文檔的編寫過程中來秽之。
- 貢獻(xiàn)patches和 bug fixes,請(qǐng)?jiān)趃ithub上按照提交規(guī)則進(jìn)行当娱。
開始第一步
如果您已經(jīng)閱讀到這里吃既,相信您已經(jīng)對(duì)BUI有了一定的了解。恭喜您跨细!您已經(jīng)成為BUI的用戶鹦倚,接下來我們可以閱讀Hello BUI!進(jìn)入學(xué)習(xí)BUI的第一環(huán)節(jié)。