An open API service indexing awesome lists of open source software.

https://github.com/billryan/gitbook-plugin-ghcomment

GitHub issue as comment for GitBook
https://github.com/billryan/gitbook-plugin-ghcomment

Last synced: 10 months ago
JSON representation

GitHub issue as comment for GitBook

Awesome Lists containing this project

README

          

# gitbook-plugin-ghcomment

[![npm](https://img.shields.io/npm/v/gitbook-plugin-ghcomment.svg?style=plastic)](https://npmjs.org/package/gitbook-plugin-ghcomment) [![npm](https://img.shields.io/npm/dm/gitbook-plugin-ghcomment.svg?style=plastic)](https://npmjs.org/package/gitbook-plugin-ghcomment) [![npm](https://img.shields.io/npm/dt/gitbook-plugin-ghcomment.svg?style=plastic)](https://npmjs.org/package/gitbook-plugin-ghcomment)

## GitHub issue comment for GitBook

plugin ghcomment is based on for displaying comments with GitHub issue.

### add plugin in `book.json`

```
{
"plugins": [
"ghcomment"
],
"ghcomment": {
"owner": "billryan",
"repo": "blog"
}
}
```

Replace `owner` and `repo` with your own issue repo. For gitbook markdown text, you should set `issue_id` in the frontmatter.

```
---
created: 2018-02-24_16-30-16
issue_id: 16
title: xxx
---
```