# hexo-migrator-github-issue

**Repository Path**: yikunkero/hexo-migrator-github-issue

## Basic Information

- **Project Name**: hexo-migrator-github-issue
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-09
- **Last Updated**: 2021-07-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Github Issue Migrator

Migrate your blog from github issue to Hexo.

## Requirements
You need to complete the setup of Hexo first, see [Hexo Setup](https://hexo.io/docs/setup.html).
``` bash
$ hexo init <folder>
$ cd <folder>
$ npm install
```

## Install

``` bash
$ npm install hexo-migrator-github-issue --save
```

## Usage

Execute the following command after installed. `owner/repo` is the github owner and repo of issue.

``` bash
$ hexo migrate github-issue owner/repo [--publish]
```

It will migrate owner/repo issue to hexo, there are some specific issue label is supported:

- "category_", set the sepecfic category for the post
- "draft", the post layout will be set to "draft", that means the post will be stored in draft dir
- "publish", if user migrate with "--publish" opt, only post with "publish" label will be created.

### Front-matter support
If you specify the front-matter in the issue content, like:

```
---
cover: http://demo.jpeg
top: 1
---
# Title
Hello World!
```

The front-matter will be transparently added in your post writings.

Note that, the front-matter in the issue content has the highest priority, that means the internal front-matter which generated by migrator (such as, `title`, `tags`, `number`, `date`) will also be replaced.

## Demo

``` bash
hexo migrate github-issue Yikun/yikun.github.com
```
It will migrate Yikun/yikun.github.com issue to hexo.

## History
- 0.1.6 add original front-matter support & remove top label support
- 0.1.5 add --publish support
- 0.1.4 category/top/draft support
- 0.1.3 issue number support
- 0.1.2 fix the title format error
- 0.1.1 tag support
- 0.1.0 Init version

## Contributor
- @Yikun tag/issue number/draft support
- @CloudyCity category/top support

Welcome to submit the issue and pull request.