utterance/utterances
1
1
Fork 0
mirror of https://github.com/utterance/utterances.git synced 2024-10-27 00:13:52 +03:00
Code Issues Projects Releases Wiki Activity
🔮 A lightweight comments widget built on GitHub issues
40 Commits 32 Branches 0 Tags 5.4 MiB
TypeScript 67.2%
SCSS 27.6%
HTML 5.2%
862a9a7d7e
Go to file
Jeremy Danyow 862a9a7d7e
Merge branch 'master' of https://github.com/utterance/utterances
2017-12-10 10:58:47 -08:00
.vscode components 2017-04-26 01:15:40 -07:00
icons cleanup scripts 2017-05-03 08:11:51 -07:00
src support disabled localStorage 2017-12-10 10:58:39 -08:00
.editorconfig initial commit 2017-04-22 21:03:47 -07:00
.gitignore cleanup scripts 2017-05-03 08:11:51 -07:00
.nojekyll cleanup scripts 2017-05-03 08:11:51 -07:00
CNAME cleanup scripts 2017-05-03 08:11:51 -07:00
package.json update deps 2017-12-10 10:56:10 -08:00
README.md Update README.md (#10) 2017-09-02 07:10:49 -07:00
tsconfig.json components 2017-04-26 01:15:40 -07:00
tslint.json components 2017-04-26 01:15:40 -07:00
utterances.json cleanup scripts 2017-05-03 08:11:51 -07:00
yarn.lock update deps 2017-12-10 10:56:10 -08:00

README.md

utterances 🔮

A lightweight comments widget using GitHub issues.

  • Open source :octocat:
  • No tracking, no ads, always free. 📡🚫
  • No lock-in. All data stored in GitHub issues. 🔓
  • Styled with Primer, the css toolkit that powers GitHub. 🎨
  • 9 KB gzipped. Vanilla TypeScript. No font downloads, no JavaScript libraries for evergreen browsers (bluebird, fetch and classList for IE 11 users) :shipit:

how it works

When Utterances loads, the GitHub issue search API is used to find the issue associated with the page based on url, pathname or title. The issue's comments are displayed in the familiar GitHub style.

When a matching issue is not found, utterances-bot will automatically create one the first time someone comments.

To comment, users must authorize the utterances app to post on their behalf using the GitHub OAuth flow. Alternatively, users can comment on the GitHub issue directly.

configuration

sites using utterances

Using utterances? Add your site to the list:

try it out 👇👇👇