# mirror

**Repository Path**: befovy/mirror

## Basic Information

- **Project Name**: mirror
- **Description**: Collect posts from different places together
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-29
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mirror

同步github issues、yuque（in progressing）上的内容，输出为 hugo 博客站点的构建内容


<!--同步 github issues 内容，并输出为 hugo 可构建的博客内容-->


## mirror 配置文件



mirror 的配置文件使用 yaml 格式， 参考 [conf.yaml](./conf.yaml)  
mirror 查找运行目录下的mirror.yaml 作为输入配置文件

配置文件中可定义多个内容来源。 每一种不同的内容来源，都有其具体的配置项。

内容来源 "issues" 具体的配置内容有

- token: github token, 需要有 issue 读取权限
- login: github username
- repo:  要抓取的 issue 所在的 repo 名称
- prefix: 输出文件名的统一前缀
- output: 转换成 hugo 博客内容后的本地输出目录，建议指定为 hugo 博客的 content 目录

## 内容来源 Issue 的抓取规则

### draft

打开的Issue 视为博客草稿，不抓取。只抓取已经关闭的 Issue 内容。


### content

issue 本身有 body 和 comment。 新建issue时的内容是body， 之后所有项目本人和其它 githuber 的追加的内容都是评论。

Mirror 支持将 Issue body 和 comment 都抓取下来余与body部分拼接合并作为完整博客内容。

由于 Issue 都是公开的，可能会被别人评论，作者还可能回复提问者。
为了区分这种情况，mirror 只拼接 comment 作者是项目作者本人， 且在 comment 开头有一句 html `<!--mirror-->` 注释语句的comment。


## Run

```shell
cp conf.yaml mirror.yaml
```
然后修改 mirror.yaml 中的内容

```shell 
go run app/main.go
```