JS 插件文檔庫邀你一起協同創作

項目概覽

項目介紹

如今,隨着大前端的發展,曾經的霸主: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
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章