抱歉，您的浏览器无法访问本站

本页面需要浏览器支持（启用）JavaScript


了解详情 >

静态博客使用 Issues API 发布动态、友链、书签

Mr. X

2020-08-23

开发
次浏览

由于发布 issue 的成本远远低于发布一次博客更新（即便是使用了持续集成），可以用 issue 来简化每个独立博客都必备的友链系统，也可以通过 issue 来快速发布动态资讯，弥补静态博客必须更新静态文件才能更新内容的缺点。此功能已经集成到了主题中，使用非常方便。

支持 GitHub 和 Gitee

实现思路

如标题所说，例如 Issues API 来实现，把请求到的结果进行解析，然后生成 HTML 标签，添加到页面中。为了获取到需要的信息，创建 Issue 需要遵循一定的格式，例如「网站卡片」就需要截图、网站标题、网站链接、网站描述、头像。可以设置 Issues 模版 来简化步骤。

演示效果

友链

/friends/

示例博客

https://volantis.js.org/examples/

注意事项

通过 issue 方式发布内容可以支持 script 脚本，为了安全起见，最好设置一个限制，例如用标签来激活 labels=active 或者只对自己发布的有效，可以在解析数据的时候过滤掉 script 标签。

如何在主题中使用？

在配置文件中开启此功能：

plugins:
  ...
  issues:
    enable: true

在 GitHub 或者 Gitee 创建仓库，仿照下面的示例，把 api 中的用户名和仓库名改成自己的。

时间线（用于发布动态）

此类型的 Issue 标题即为时间，内容不需要什么格式。

{% issues timeline | api=https://gitee.com/api/v5/repos/xaoxuu/timeline/issues?state=open&creator=xaoxuu&sort=created&direction=desc&page=1&per_page=100 %}
查看效果

上述示例对应的仓库链接：

Gitee: xaoxuu/timeline

https://gitee.com/xaoxuu/timeline/issues

网站卡片（用于书签、收藏夹、友链）

此类型的 Issue 内容中需要有一段满足 JSON 格式的代码块：

{
    "title": "",
    "description": "",
    "screenshot": "",
    "url": "",
    "avatar": "",
    "version": "版本：^4.0"
}

示例代码：

{% issues sites | api=https://api.github.com/repos/volantis-x/examples/issues?sort=updated&state=open&page=1&per_page=100 | group=version:版本：^4.0,版本：^3.0,版本：^2.0 %}

上述示例对应的仓库链接：

GitHub: volantis-x/examples

https://github.com/volantis-x/examples/issues

头像卡片（用于友链、成员列表）

此类型的 Issue 标题即为链接，内容需要满足以下格式：

{
    "title": "",
    "description": "",
    "screenshot": "",
    "url": "",
    "avatar": ""
}

示例代码：

{% issues sites | api=https://api.github.com/repos/xaoxuu/friends/issues?sort=updated&state=open&page=1&per_page=100&labels=active %}

上述示例对应的仓库链接：

GitHub: xaoxuu/friends

https://github.com/xaoxuu/friends/issues

头像卡片目前还未开发，请先使用网站卡片代替。

相关文章
macOS10.12 最新版 CocoaPods 的安装及使用本文最新更新于2019年8月，macOS10.15中可用。如何发布开源库到 CocoaPods说实在话，类似的教程网上很多，基本可以满足大多数人零基础发布 CocoaPods，但是其中可能会遇到一些问题，只有亲自尝试...

博客内容遵循 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 协议

本文永久链接是：https://xaoxuu.com/blog/2020-08-23-issues-api/

最后更新于：2020年12月6日星期日 17:16

评论