diff --git a/README.md b/README.md index ed6930ee08..5954d640ae 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,13 @@ If you would like to add a [fade-in-down effect](http://daneden.github.io/animat See [documentation](http://bryanbraun.github.io/anchorjs/#basic-usage) for more options. +### Utterances +[Utterances](https://utteranc.es/): _A lightweight comments widget built on GitHub issues. Use GitHub issues for blog comments, wiki pages and more!_ You can turn it on by adding a github repository to `utterances_repo`, in the form of `user/repo-name`. + +The issue terminology can be customized using key `utterances_issue-term`, the default is `"pathname"`, some of the other options are `"url"` and `"title"`. The full list of options can be found in the official documentation. + +The theme can be changed using key `utterances_theme`, the default is `github-light`, the full list as of today is: `github-dark`, `github-dark-orange`, `icy-dark`, `dark-blue`, `photon-dark`. You can also find this list on the official website. + ### Put in a Pixyll Plug If you want to give credit to the Pixyll theme with a link to or my personal website somewhere, that'd be awesome. No worries if you don't. diff --git a/_config.yml b/_config.yml index 2da1cbb5f9..8845401190 100644 --- a/_config.yml +++ b/_config.yml @@ -40,6 +40,12 @@ fb_page_id: # (leave blank to disable Disqus) disqus_shortname: +# Utterances github comments (utterances_repo: github_username/repository) +# (leave blank to disable Utterances) +utterances_repo: +utterances_issue-term: pathname +utterances_theme: github-light + # Facebook Comments plugin # (leave blank to disable Facebook Comments, otherwise set it to true) facebook_comments: diff --git a/_layouts/post.html b/_layouts/post.html index a8f4763a74..ed6bc8c56a 100644 --- a/_layouts/post.html +++ b/_layouts/post.html @@ -50,6 +50,16 @@

{{ page.title }}

{% endif %} +{% if site.utterances_repo %} + +{% endif %} + {% if site.facebook_comments %}
{% endif %}