1.0.1 • Published 4 years ago

git-issues-blog v1.0.1

Weekly downloads
1
License
ISC
Repository
-
Last release
4 years ago

shero-cli 使用说明

shero-cli是什么?

很多程序员平时喜欢使用git的issue来编写博客,因为issue里的comment部分能够提供一个作者和读者之间沟通讨论的平台。但是使用issue编写博客的话,涉及到博客内容和issue直接的关系需要维护,作者需要自己维护一个博客仓库,然后在博客完成后再复制到issue。 为了让利用github的issue来开发博客变得更加愉快,就开发了shero-cli这款工具。主要提供的功能有:

  • 命令行式创建博客
  • 命令行式发布博客
  • 将仓库里的md文件生成目录列表,降低维护成本

项目设计图

项目设计图

怎么用

1. shero-cli安装

npm install shero-cli -g

2. shero-cli初始化

shero-cli init

需要根据提示输入用户名,仓库名和token。 token的获取请参考这篇文章关于获取git的token。先在页面中生成对应的token,在拷贝到命令行中。

3. 创建一篇博客

shero-cli create <blogName>
  • 注意blogName就是博客名称,也会作为issue的标题展示
  • blogName是必填项,.md后缀可不填,默认生成md文件

4. 发布或更新一篇博客

shero-cli publish [blogName]

shero-cli自动识别publish的博客是否存在,存在的话就是更新博客,不存在就新建博客。

TODO list

这个工具我是先开发一个版本,有的功能还要继续的新增和完善。也欢迎rd朋友提出自己的想法和建议,甚至参与到这个工具的开发中。

  • shero-cli close blogName (issue 的关闭)
  • shero-cli delete blogName
  • 支持博客头部和尾部使用模板
  • 支持博客分类

参考文章

nodejs api 官网

关于获取git的token

封装好了的github api => octokit