Skip to content

Commit 1777837

Browse files
committed
docs(readme): add private option description to the readme#usage
1 parent f5deb4b commit 1777837

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,26 @@ You should set `repo` in your `book.json`.
3333
}
3434
```
3535

36+
- `private`: `boolean` (optional, default is `false`)
37+
38+
For private repositories, set this flag.
39+
40+
```json
41+
{
42+
"gitbook": ">=3.0.0",
43+
"title": "Example",
44+
"plugins": [
45+
"github-issue-feedback"
46+
],
47+
"pluginsConfig": {
48+
"github-issue-feedback": {
49+
"repo": "your/private_repo",
50+
"private": true
51+
}
52+
}
53+
}
54+
```
55+
3656
## Changelog
3757

3858
See [Releases page](https://github.com/azu/gitbook-plugin-github-issue-feedback/releases).

0 commit comments

Comments
 (0)