https://github.com/tipsy/gh-comments

https://github.com/tipsy/gh-comments

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tipsy/gh-comments
• Owner: tipsy
• License: apache-2.0
• Created: 2017-08-05T09:12:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-08T23:08:14.000Z (over 8 years ago)
• Last Synced: 2025-01-30T00:22:10.558Z (11 months ago)
• Language: JavaScript
• Size: 28.3 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Add comments to any webpage

## Installation and usage

Simply include the gh-comments JS/CSS files and paste the following snippet where you want your comment section:

```html



    

        githubComments({

            user: 'tipsy', // your github-username

            repo: 'gh-comments', // your github-repo

            issueNr: 1 // your issue number

        });

    



```


You need to create one issue per comments section. All comments from the issue will be fetched and put into the `
` tag. By default, the comments are styled just like GitHub comments, but you can easily switch out the CSS.


### NPM

...

## Limitations

The plugin uses the official GitHub API, which has a rate-limit of 60 request per IP per hour, meaning that your users would have to reload the plugin more than 60 times in one hour in order to hit the rate-limit.

## Browser support

All the way down to IE9.