# git-issues-blog

> ### shero-cli是什么？ 很多程序员平时喜欢使用git的issue来编写博客，因为issue里的comment部分能够提供一个作者和读者之间沟通讨论的平台。但是使用issue编写博客的话，涉及到博客内容和issue直接的关系需要维护，作者需要自己维护一个博客仓库，然后在博客完成后再复制到issue。 为了让利用github的issue来开发博客变得更加愉快，就开发了shero-cli这款工具。主要提供的功能有： - 命令行式创建博客 - 命令行式发布博客 - 将仓库里的md文件生成目录列表，降低

Latest version **1.0.1** (published 2020-06-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install git-issues-blog
pnpm add git-issues-blog
yarn add git-issues-blog
bun add git-issues-blog
```

Provides the command `shero-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-06-18 |
| First published | 2020-06-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 84.3 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | kinyaying |

## Links

- npm: https://www.npmjs.com/package/git-issues-blog
- npm.io page: https://npm.io/package/git-issues-blog

## Dependencies (15)

- [ejs](https://npm.io/package/ejs.md) ^3.1.3
- [ini](https://npm.io/package/ini.md) ^1.3.5
- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [ora](https://npm.io/package/ora.md) ^4.0.4
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [request](https://npm.io/package/request.md) ^2.88.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.2.0
- [babel-cli](https://npm.io/package/babel-cli.md) ^6.26.0
- [babel-env](https://npm.io/package/babel-env.md) ^2.4.1
- [commander](https://npm.io/package/commander.md) ^5.1.0
- [metalsmith](https://npm.io/package/metalsmith.md) ^2.3.0
- [consolidate](https://npm.io/package/consolidate.md) ^0.15.1
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^18.0.0
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^3.0.2

## Recent versions

- 1.0.1 (latest) — 2020-06-18
- 1.0.0 — 2020-06-18

## README

#### shero-cli 使用说明

### shero-cli是什么？
很多程序员平时喜欢使用git的issue来编写博客，因为issue里的comment部分能够提供一个作者和读者之间沟通讨论的平台。但是使用issue编写博客的话，涉及到博客内容和issue直接的关系需要维护，作者需要自己维护一个博客仓库，然后在博客完成后再复制到issue。
为了让利用github的issue来开发博客变得更加愉快，就开发了shero-cli这款工具。主要提供的功能有：
- 命令行式创建博客
- 命令行式发布博客
- 将仓库里的md文件生成目录列表，降低维护成本


### 项目设计图
![项目设计图](./img/1.jpg)

### 怎么用

**1. shero-cli安装**
```shell
npm install shero-cli -g
```

**2. shero-cli初始化**
```shell
shero-cli init
```
需要根据提示输入用户名，仓库名和token。
token的获取请参考这篇文章[关于获取git的token](https://dev.to/gr2m/github-api-authentication-personal-access-tokens-53kd)。先在页面中生成对应的token，在拷贝到命令行中。

**3. 创建一篇博客**
```shell
shero-cli create <blogName>
```
- 注意blogName就是博客名称，也会作为issue的标题展示
- blogName是必填项，.md后缀可不填，默认生成md文件

**4. 发布或更新一篇博客**
```shell
shero-cli publish [blogName]
```
**shero-cli**自动识别publish的博客是否存在，存在的话就是更新博客，不存在就新建博客。

### TODO list
这个工具我是先开发一个版本，有的功能还要继续的新增和完善。也欢迎rd朋友提出自己的想法和建议，甚至参与到这个工具的开发中。
- [ ] shero-cli close [blogName] (issue 的关闭)
- [ ] shero-cli delete [blogName] (博客的删除)
- [ ] 支持博客头部和尾部使用模板
- [ ] 支持博客分类

### 参考文章
[nodejs api 官网](http://nodejs.cn/api/fs.html#fs_fs_readfile_path_options_callback)

[关于获取git的token](https://dev.to/gr2m/github-api-authentication-personal-access-tokens-53kd)

封装好了的github api => [octokit](https://octokit.github.io/rest.js/v18#issues-create)

---
_Source: https://npm.io/package/git-issues-blog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._