JS 插件文檔庫邀你一塊兒協同創做

項目概覽

• JS 插件文檔庫地址：JS 插件文檔庫 · 語雀
• 在線演示代碼倉庫：JS 插件文檔庫示例代碼 · GitHub
• 在線預覽：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