你的第一个用github issue做的博客

723 阅读2分钟

每个做技术的都会有一个自己独立的空间,不管这块空间是在已经存在的像知乎、掘金、语雀,或者是其他各种笔记软件,还是部署在自己的服务器上。前段时间我看到很多博客都在github上用issue来写,但是每次都要写好markdown文章,然后拷贝到github issue里面。对于一个技术控来说,就会产生一个疑问:如何用一个东西来自动完成这一行为?

现在就用目前流行的vscode生态的一个插件来完成。

主要需求

  1. 能把本地markdown文档传到github issue
  2. 能更新本地markdown文档到github指定的issue

实现

首先可以肯定是要请求githubopen api,然后找到集成github api@octokit/rest

然后需求中需要存储对应的issue id,所以决定采用yaml header,然后找到js操作yamljs-yaml

@octokit/rest支持oauth认证方式,但是需要一个回调地址,此时发现settings-sync内部有一个express服务。

使用

首先在需要安装插件issue-blog,可以直接在vscode插件列表中搜索,或者点击链接安装

认证

在第一次使用之前,需要先进行oauth认证,然后配置对应的仓储名称,在vscode中按cmd/ctl + shift + p执行以Issue:开头的任意命令

认证成功后浏览器会跳到如下页面

新建博客

vscode中按cmd/ctl + shift + p执行Issue: Create Issue,在此之前需要确保自己在一个markdown文件

更新博客

这是主要需求,在此之外,此插件还实现了

获取博客列表

此功能是将仓储中的open状态的issue展示出来,目前实现了点击之后可以跳转到对应的issue

获取仓储pull request列表

此功能是为了使用pr提交代码的团队,方便拿到pr去review,目前实现了点击之后可以跳转到对应的pr

Reference

仓储地址 插件地址