releasenotes.js是一款能够从Github之上抓取托管代码情况,并自动生成发行日志的小工具。
代码使用jsonp从github上抓取数据,最终呈现在网页上。
如何使用
前端
$(document).ready(function() {
$("#releaseNotesContainer").releaseNotes({
milestonesShown : 10,
// 如果需要获取一个私有仓库的情况
// 那么你必须使用一个api.php来获取访问许可
// 反之,phpApi以及phpApiPath都可以不必设置
phpApi : true,
phpApiPath : '/',
showDescription : true,
showComments : true,
// 不使用phpAPI则要在下面设置你的仓库名和用户名
repo : 'rails',
username : 'rails'
});
});
别忘了包含我们的库代码:
以及一个恰当的CSS文件
后端
只有当你需要使用私有仓库时,你才需要phpApi.php。一旦如此,你就必须修改该文件的前几行:
$configs = array(
"username" => "user", // Github 用户名
"password" => "password", // Github 帐号密码
"repo" => "repository" // Github 仓库名
);
可以放心的是,这个phpApi.php只会帮你获取数据给前台,并不会将密码泄露到前台。
许可证
releasenotes.js使用MIT许可证,不过作者还是希望能够得到一些捐赠。