{"id":21461570,"url":"https://github.com/snowdreams1006/gitbook-plugin-mygitalk","last_synced_at":"2025-07-15T03:30:24.912Z","repository":{"id":135332013,"uuid":"184264705","full_name":"snowdreams1006/gitbook-plugin-mygitalk","owner":"snowdreams1006","description":"Mygitalk is a gitbook comment plugin based on gitalk","archived":false,"fork":false,"pushed_at":"2024-08-15T06:34:05.000Z","size":2325,"stargazers_count":7,"open_issues_count":24,"forks_count":5,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-28T01:48:40.618Z","etag":null,"topics":["comment","discuss","gitalk","gitbook-plugin-mygitalk","gitment","issue","mygitalk"],"latest_commit_sha":null,"homepage":"https://snowdreams1006.github.io/gitbook-plugin-mygitalk/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snowdreams1006.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-30T13:13:30.000Z","updated_at":"2024-08-15T06:34:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"0ade0e97-d7d2-4b61-bef7-9a06c5f45f72","html_url":"https://github.com/snowdreams1006/gitbook-plugin-mygitalk","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/snowdreams1006/gitbook-plugin-mygitalk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-mygitalk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-mygitalk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-mygitalk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-mygitalk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snowdreams1006","download_url":"https://codeload.github.com/snowdreams1006/gitbook-plugin-mygitalk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snowdreams1006%2Fgitbook-plugin-mygitalk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263707029,"owners_count":23499076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comment","discuss","gitalk","gitbook-plugin-mygitalk","gitment","issue","mygitalk"],"created_at":"2024-11-23T07:09:48.517Z","updated_at":"2025-07-15T03:30:24.509Z","avatar_url":"https://github.com/snowdreams1006.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gitbook-plugin-mygitalk\r\n\r\n[![npm version](https://img.shields.io/npm/v/gitbook-plugin-mygitalk.svg)](https://www.npmjs.com/package/gitbook-plugin-mygitalk)\r\n[![npm-download](https://img.shields.io/npm/dt/gitbook-plugin-mygitalk.svg)](https://www.npmjs.com/package/gitbook-plugin-mygitalk)\r\n[![npm-license](https://img.shields.io/npm/l/gitbook-plugin-mygitalk.svg)](https://www.npmjs.com/package/gitbook-plugin-mygitalk)\r\n[![github](https://img.shields.io/badge/github-snowdreams1006-brightgreen.svg)](https://github.com/snowdreams1006)\r\n[![微信公众号](https://img.shields.io/badge/%E5%BE%AE%E4%BF%A1%E5%85%AC%E4%BC%97%E5%8F%B7-%E9%9B%AA%E4%B9%8B%E6%A2%A6%E6%8A%80%E6%9C%AF%E9%A9%BF%E7%AB%99-brightgreen.svg)](https://snowdreams1006.github.io/snowdreams1006-wechat-public.jpeg)\r\n\r\n`Mygitalk` is a **gitbook comment plugin** based on `gitalk`.\r\n\r\nIf you want to know the story behind `mygitalk`, please visit [gitbook-plugin-mygitalk](https://snowdreams1006.github.io/gitbook-plugin-mygitalk/).\r\n\r\n## Feature\r\n\r\n- Authentication with github account\r\n- Serverless, all comments will be stored as github issues\r\n- Both personal and organization github projects can be used to store comments \r\n- Localization, support multiple languages [en, zh-CN, zh-TW, es-ES, fr, ru]\r\n- Facebook-like distraction free mode (Can be enabled via the `distractionFreeMode` option)\r\n- Hotkey submit comment (cmd|ctrl + enter)\r\n\r\n## Usage\r\n\r\n- Install this plugin\r\n\r\nAdd `mygitalk` to `plugins` in `book.json` configuration file.\r\n\r\n```json\r\n{\r\n    \"plugins\" : [\"mygitalk\"]\r\n}\r\n```\r\n\r\nInstall `mygitalk` via `npm` or `gitbook` .\r\n\r\n```bash\r\n$ npm install gitbook-plugin-mygitalk\r\n```\r\n\r\nor \r\n\r\n```bash\r\n$ gitbook install\r\n```\r\n\r\n- Configure this plugin\r\n\r\nPrepare a `GitHub application` , if you don't have one, [Click here](https://github.com/settings/applications/new) to register a new one.\r\n\r\nAdd it to your `book.json` with a basic configuration\r\n\r\n```json\r\n{\r\n  \"pluginsConfig\": {\r\n    \"mygitalk\": {\r\n        \"clientID\": \"GitHub Application Client ID\",\r\n        \"clientSecret\": \"GitHub Application Client Secret\",\r\n        \"repo\": \"GitHub repo\",\r\n        \"owner\": \"GitHub repo owner\",\r\n        \"admin\": [\"GitHub repo owner and collaborators, only these guys can initialize github issues\"],\r\n        \"distractionFreeMode\": false\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n- Run `gitbook` locally\r\n\r\nRun `gitbook build` or `gitbook serve` to verify this plugin is in effect and should not have been initialized yet.\r\n\r\n- Release `gitbook` officially\r\n\r\nPublish to the production environment to implement the comment function really.\r\n\r\n- `Star` this plugin\r\n\r\nIf you feel this plugin is helpful, feel free to `star` [gitbook-plugin-mygitalk](https://github.com/snowdreams1006/gitbook-plugin-mygitalk).\r\n\r\n## Example\r\n\r\nThe [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).\r\n\r\n## Feedback\r\n\r\nI am very happy to help out with your books or any other questions you might have. see [snowdreams1006](https://github.com/snowdreams1006)\r\n\r\nYou can email [me](mailto:snowdreams1006@163.com) or [new issue](https://github.com/snowdreams1006/gitbook-plugin-mygitalk/issues) on github.\r\n\r\n![snowdreams1006-wechat-donate.jpg](https://snowdreams1006.github.io/snowdreams1006-wechat-donate.jpg)\r\n\r\n## License\r\n\r\n`gitbook-plugin-mygitalk` is licensed under `Apache-2.0` License. See [LICENSE](LICENSE) for the full license text.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-mygitalk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-mygitalk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnowdreams1006%2Fgitbook-plugin-mygitalk/lists"}