https://github.com/snowdreams1006/gitbook-plugin-mygitalk
Mygitalk is a gitbook comment plugin based on gitalk
https://github.com/snowdreams1006/gitbook-plugin-mygitalk
comment discuss gitalk gitbook-plugin-mygitalk gitment issue mygitalk
Last synced: 7 months ago
JSON representation
Mygitalk is a gitbook comment plugin based on gitalk
- Host: GitHub
- URL: https://github.com/snowdreams1006/gitbook-plugin-mygitalk
- Owner: snowdreams1006
- License: apache-2.0
- Created: 2019-04-30T13:13:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-15T06:34:05.000Z (over 1 year ago)
- Last Synced: 2025-05-28T01:48:40.618Z (9 months ago)
- Topics: comment, discuss, gitalk, gitbook-plugin-mygitalk, gitment, issue, mygitalk
- Language: JavaScript
- Homepage: https://snowdreams1006.github.io/gitbook-plugin-mygitalk/
- Size: 2.22 MB
- Stars: 7
- Watchers: 0
- Forks: 5
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitbook-plugin-mygitalk
[](https://www.npmjs.com/package/gitbook-plugin-mygitalk)
[](https://www.npmjs.com/package/gitbook-plugin-mygitalk)
[](https://www.npmjs.com/package/gitbook-plugin-mygitalk)
[](https://github.com/snowdreams1006)
[](https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg)
`Mygitalk` is a **gitbook comment plugin** based on `gitalk`.
If you want to know the story behind `mygitalk`, please visit [gitbook-plugin-mygitalk](https://snowdreams1006.github.io/gitbook-plugin-mygitalk/).
## Feature
- Authentication with github account
- Serverless, all comments will be stored as github issues
- Both personal and organization github projects can be used to store comments
- Localization, support multiple languages [en, zh-CN, zh-TW, es-ES, fr, ru]
- Facebook-like distraction free mode (Can be enabled via the `distractionFreeMode` option)
- Hotkey submit comment (cmd|ctrl + enter)
## Usage
- Install this plugin
Add `mygitalk` to `plugins` in `book.json` configuration file.
```json
{
"plugins" : ["mygitalk"]
}
```
Install `mygitalk` via `npm` or `gitbook` .
```bash
$ npm install gitbook-plugin-mygitalk
```
or
```bash
$ gitbook install
```
- Configure this plugin
Prepare a `GitHub application` , if you don't have one, [Click here](https://github.com/settings/applications/new) to register a new one.
Add it to your `book.json` with a basic configuration
```json
{
"pluginsConfig": {
"mygitalk": {
"clientID": "GitHub Application Client ID",
"clientSecret": "GitHub Application Client Secret",
"repo": "GitHub repo",
"owner": "GitHub repo owner",
"admin": ["GitHub repo owner and collaborators, only these guys can initialize github issues"],
"distractionFreeMode": false
}
}
}
```
- Run `gitbook` locally
Run `gitbook build` or `gitbook serve` to verify this plugin is in effect and should not have been initialized yet.
- Release `gitbook` officially
Publish to the production environment to implement the comment function really.
- `Star` this plugin
If you feel this plugin is helpful, feel free to `star` [gitbook-plugin-mygitalk](https://github.com/snowdreams1006/gitbook-plugin-mygitalk).
## Example
The [gitbook-plugin-mygitalk](https://github.com/snowdreams1006/gitbook-plugin-mygitalk) project has been integrated with the plugin itself or you can refer to the [sample project](https://github.com/snowdreams1006/gitbook-plugin-mygitalk/tree/master/example).
## Feedback
I am very happy to help out with your books or any other questions you might have. see [snowdreams1006](https://github.com/snowdreams1006)
You can email [me](mailto:snowdreams1006@163.com) or [new issue](https://github.com/snowdreams1006/gitbook-plugin-mygitalk/issues) on github.
## License
`gitbook-plugin-mygitalk` is licensed under `Apache-2.0` License. See [LICENSE](LICENSE) for the full license text.