JS 外掛文件庫,邀請你一起協同創作

魯鵬發表於2019-04-13

專案概覽

專案介紹

如今,隨著大前端的發展,曾經的霸主:jQuery 也漸漸的隕落,隨之一起沒落的,也包含基於 jQuery 的一些優秀的外掛。這些優秀的外掛,讓我們在前端的開發中,節省了大量的時間。自己的專案中也使用了大部分基於 jQuery 的前端外掛,幫助我實現了很多的功能,節省了大量的開發時間。

所以,我計劃發起一個開源專案,整理並收集這些優秀的前端外掛的使用方法,並提供示例程式碼,可供除錯和學習。一來為了留個存檔,二來也是為了分享出去,幫助到需要的人。

該文件起於 jQuery 框架,但不止於 jQuery,希望能整理所有的 Web 前端框架。

期待你的加入,一起維護文件,語雀文件協作邀請連結,如果連結過期,請加個人微訊號:P_lu0503,並備註:文件協作

為了文件的可用性,我希望每一個外掛都有一篇獨立文件,以及獨立線上演示。

文件介紹

文件在語雀平臺上,期待你的加入進行協作編寫,不要求所有的配置項都介紹到,列舉一些最常見的即可。文件主要包括以下幾個方面的描述:

  • 簡單介紹:外掛的用途,使用場景,以及官方文件連結;
  • 開始使用:如何正確的引入庫檔案到頁面中,這一點對於初學者很重要;
  • 使用示例(需要程式碼演示):
    • 前臺 HTML 如何編寫
    • 前臺 JS 如何呼叫
    • 後臺資料返回的格式(不限後臺技術,重點關注返回資料的格式)

線上演示

每一個外掛都有一個獨立的頁面可供訪問,線上演示原始碼在 GitHub 上,採用 Node 語言編寫,可以自行部署在本地,便於除錯,嘗試外掛不同引數的用法。

熟悉 Node + Express 框架的可以直接 fork 專案,並提交 pull requests,如果不熟悉 Node 開發,也沒關係,我會定期將文件中新增的外掛,做成演示示例,push 到 GitHub 倉庫。

另外,也提供了線上預覽

本地部署步驟

  1. 安裝 Node 環境
  2. 安裝 supervisor,安裝方法:npm i -g supervisor
  3. 安裝 bower 包管理器,安裝方法:npm i -g bower
  4. 克隆程式碼到本地,順便點個 Star
  5. 進入專案目錄,安裝依賴,npm install 以及 bower install
  6. 執行專案,npm start
  7. 瀏覽器開啟專案:http://localhost:3030/page

相關文章