WeixuanZ / utterances

:crystal_ball: A lightweight comments widget built on GitHub issues
https://weixuanz.github.io/utterances/
MIT License
1 stars 0 forks source link

utterances ๐Ÿ”ฎ

This is a fork of the amazing utterances for comments on my blog - https://weixuanz.github.io. Modified to use self-hosted utterances-oauth, and styles matching my blog.

utterances is a lightweight comments widget built on GitHub issues. Use GitHub issues for blog comments, wiki pages and more!

To serve locally, execute yarn start, then go to http://localhost:4000/utterances/index.html. Use yarn run deploy to deploy to GitHub Pages.

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. If we cannot find an issue that matches the page, no problem, utterances-bot will automatically create an issue 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.