在前端开发过程中,我们经常会遇到需要展示 GitHub 仓库的 Issues 的需求。此时,我们可以使用 hexo-generator-issues,一个方便快捷的 npm 包,来自动生成 Issues 页面。
安装 hexo-generator-issues
首先,我们需要确定已经安装了 Hexo。如果没有安装 Hexo,可以使用以下命令进行安装:
npm install hexo-cli -g
接下来,我们需要安装 hexo-generator-issues,使用 npm 命令:
npm install hexo-generator-issues --save
安装完成后,我们需要配置 hexo-generator-issues 的参数。
配置 hexo-generator-issues
在 Hexo 的 _config.yml
文件中添加以下配置:
issues_generator: repo: repo-name # GitHub 仓库名 owner: owner-name # GitHub 用户名 per_page: 10 # 每页展示的 Issues 数量,可选,默认为 10 labels: label1,label2 # 类型为字符创,Issues 中需要展示的标签名称,会按照标签名称分页,可选
使用 hexo-generator-issues
配置完成后,我们可以使用以下命令启动 hexo-generator-issues:
hexo clean && hexo generate && hexo server
此时,可以在本地服务器上通过访问 http://localhost:4000/issues 页面来查看生成的 Issues。
示例代码
以下是一个使用 hexo-generator-issues 的示例代码:
issues_generator: repo: hexo-generator-issues owner: hexojs per_page: 20 labels: help wanted
使用以上配置参数,可以生成一个用于展示 Hexo 的 issues 包含 help wanted 标签,每页最多展示 20 条的 Issues 列表。
总结
在本文中,我们学习了如何使用 hexo-generator-issues 这个 npm 包,在 Hexo 站点中自动生成 GitHub 仓库的 Issues 页面。通过学习本文,我们可以更加方便地为自己的网站增加 Issues 页面。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005730781e8991b448e9323