每个做技术的都会有一个自己独立的空间,不管这块空间是在已经存在的像知乎、掘金、语雀,或者是其他各种笔记软件,还是部署在自己的服务器上。前段时间我看到很多博客都在github
上用issue
来写,但是每次都要写好markdown
文章,然后拷贝到github issue
里面。对于一个技术控来说,就会产生一个疑问:如何用一个东西来自动完成这一行为?
现在就用目前流行的vscode生态的一个插件来完成。
主要需求
- 能把本地
markdown
文档传到github issue
中 - 能更新本地
markdown
文档到github
指定的issue
中
实现
首先可以肯定是要请求github
的open api,然后找到集成github api
的@octokit/rest
然后需求中需要存储对应的issue id
,所以决定采用yaml header
,然后找到js
操作yaml
的js-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
- 本文链接: https:https://whyour.cn/post/create-blog-with-github-issue.html
- 最后更新于:
- 版权声明: 本博客所有文章除特别声明外,均采用 署名 4.0 国际(CC BY 4.0) 许可协议。转载请注明出处!