{"id":16232467,"url":"https://github.com/nishantwrp/gridsome-plugin-gitalk","last_synced_at":"2025-04-08T06:47:29.846Z","repository":{"id":57254197,"uuid":"268333774","full_name":"nishantwrp/gridsome-plugin-gitalk","owner":"nishantwrp","description":"A plugin that simplifies adding Gitalk comments to Gridsome.","archived":false,"fork":false,"pushed_at":"2021-08-20T18:39:32.000Z","size":12,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-14T04:33:29.604Z","etag":null,"topics":["comment-system","gitalk","gridsome","gridsome-plugin","vue-gitalk"],"latest_commit_sha":null,"homepage":"https://yarnpkg.com/package/gridsome-plugin-gitalk","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nishantwrp.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}},"created_at":"2020-05-31T17:53:34.000Z","updated_at":"2021-08-20T18:38:21.000Z","dependencies_parsed_at":"2022-08-31T08:21:37.913Z","dependency_job_id":null,"html_url":"https://github.com/nishantwrp/gridsome-plugin-gitalk","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nishantwrp%2Fgridsome-plugin-gitalk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nishantwrp%2Fgridsome-plugin-gitalk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nishantwrp%2Fgridsome-plugin-gitalk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nishantwrp%2Fgridsome-plugin-gitalk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nishantwrp","download_url":"https://codeload.github.com/nishantwrp/gridsome-plugin-gitalk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247792920,"owners_count":20996896,"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-system","gitalk","gridsome","gridsome-plugin","vue-gitalk"],"created_at":"2024-10-10T13:09:06.518Z","updated_at":"2025-04-08T06:47:29.824Z","avatar_url":"https://github.com/nishantwrp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Gridsome Plugin Gitalk\n\u003ca href=\"https://npmjs.com/package/gridsome-plugin-gitalk\"\u003e\u003cimg src=\"https://badge.fury.io/js/gridsome-plugin-gitalk.svg\" alt=\"npm version\"\u003e\u003c/a\u003e \u003cimg src=\"https://badgen.net/github/license/nishantwrp/gridsome-plugin-gitalk\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/dt/gridsome-plugin-gitalk\"\u003e\n\nA plugin that simplifies adding [Gitalk](https://github.com/gitalk/gitalk) comments to Gridsome.\n\n\n## Installation\n\n```\n# For npm\n$ npm install gridsome-plugin-gitalk\n# For yarn\n$ yarn add gridsome-plugin-gitalk\n```\n\n## Tutorial\nRefer to [this blog](https://www.nishantwrp.com/posts/add-github-based-comments-on-your-gridsome-blog/) for a detailed tutorial on how to use and configure this plugin.\n\n## Usage\n\nAdd this plugin to your  `gridsome.config.js`\n\n```js\nplugins: [\n  {\n    use:  'gridsome-plugin-gitalk',\n    options: {\n      clientID:  '',\n      ... // Gitalk config\n    }\n  }\n]\n```\nThen simply add the following line to your Vue files.\n```html\n\u003cGitalk /\u003e\n```\nYou can also specify options in the component itself like.\n```html\n\u003cGitalk :config={\n  id: 'hi',\n  ...\n} /\u003e\n```\n\u003e **Note**: If same option is specified in the `gridsome.config.js` and the component. The value in the component would be considered.\n\n## Config Options\n\n- **clientID** `String`\n\n  **Required**. GitHub Application Client ID.\n\n- **clientSecret** `String`\n\n  **Required**. GitHub Application Client Secret.\n\n- **repo** `String`\n\n  **Required**. GitHub repository.\n\n- **owner** `String`\n\n  **Required**. GitHub repository owner. Can be personal user or organization.\n\n- **admin** `Array`\n\n  **Required**. GitHub repository owner and collaborators. (Users who having write access to this repository)\n\n- **id** `String`\n\n  Default: `location.href`.\n\n  The unique id of the page. Length must less than 50.\n\n- **number** `Number`\n\n  Default: `-1`.\n\n  The issue ID of the page, if the `number` attribute is not defined, issue will be located using `id`.\n\n- **labels** `Array`\n\n  Default: `['Gitalk']`.\n\n  GitHub issue labels.\n\n- **title** `String`\n\n  Default: `document.title`.\n\n  GitHub issue title.\n\n- **body** `String`\n\n  Default: `location.href + header.meta[description]`.\n\n  GitHub issue body.\n\n- **language** `String`\n\n  Default: `navigator.language || navigator.userLanguage`.\n\n  Localization language key, `en`, `zh-CN` and `zh-TW` are currently available.\n\n- **perPage** `Number`\n\n  Default: `10`.\n\n  Pagination size, with maximum 100.\n\n- **distractionFreeMode** `Boolean`\n\n  Default: false.\n\n  Facebook-like distraction free mode.\n\n- **pagerDirection** `String`\n\n  Default: 'last'\n\n  Comment sorting direction, available values are `last` and `first`.\n\n- **createIssueManually** `Boolean`\n\n  Default: `false`.\n\n  By default, Gitalk will create a corresponding github issue for your every single page automatically when the logined user is belong to the `admin` users. You can create it manually by setting this option to `true`.\n\n- **proxy** `String`\n\n  Default: `https://cors-anywhere.herokuapp.com/https://github.com/login/oauth/access_token`.\n\n  GitHub oauth request reverse proxy for CORS. [Why need this?](https://github.com/isaacs/github/issues/330)\n\n- **flipMoveOptions** `Object`\n\n  Default:\n  ```js\n    {\n      staggerDelayBy: 150,\n      appearAnimation: 'accordionVertical',\n      enterAnimation: 'accordionVertical',\n      leaveAnimation: 'accordionVertical',\n    }\n  ```\n\n  Comment list animation. [Reference](https://github.com/joshwcomeau/react-flip-move/blob/master/documentation/enter_leave_animations.md)\n\n- **enableHotKey** `Boolean`\n\n  Default: `true`.\n\n  Enable hot key (cmd|ctrl + enter) submit comment.\n\n\n## License (MIT)\n\nOpen [LICENSE](./LICENSE) file for more info\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnishantwrp%2Fgridsome-plugin-gitalk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnishantwrp%2Fgridsome-plugin-gitalk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnishantwrp%2Fgridsome-plugin-gitalk/lists"}