项目概览
- 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 堆栈。
别的,也供应了在线预览。
当地布置步骤
- 装置 Node 环境
- 装置 supervisor,装置要领:
npm i -g supervisor
- 装置 bower 包管理器,装置要领:
npm i -g bower
- 克隆代码到当地,趁便点个 Star
- 进入项目目次,装置依靠,
npm install
以及bower install
- 运转项目,
npm start
- 浏览器翻开项目:
http://localhost:3030/page