Adding GitHub comments to this website
Published:
I came across Giscus at the bottom of a Cosma listing on kausalflow.com. Giscus provides a simple way to add GitHub comments to a Jekyll website (like this one). This allows anyone to comment on my website using GitHub Discussions! The setup process was surprisingly simple, only taking me about 10-15 minutes to complete and troubleshoot.
To add comments via GitHub Discussions to an academic pages website (like this one), go to Giscus and follow the step by step instructions in the configuration section. Be sure that the repository meets all three criteria listed in the Repository
section for Giscus to work.
Step by Step Instructions on https://giscus.app
Repository
section: Enter the repository name (e.g.mtillman14/mtillman14.github.io
).Page <-> Discussion
: I recommend leaving the default.Discussion Category
: I recommend either creating a newComments
category in your GitHub repo’s Discussions (be sure to set its type toAnnouncements
), or using theAnnouncements
category that Giscus recommends.Features
: I only selectedEnable reactions for the main post
and left the others blank.Theme
: I left the defaultPreferred color scheme
.
Adding the Giscus script to the Academic Pages website
- In the
_includes/comments-providers/custom.html
file, paste the Giscus script from the Giscus website. It should be customized to your repository information after filling out the configuration. - In the
_config.yml
file, setcomments.provider
to"custom"
.
That’s it! After committing and pushing these changes, you should see a comments section at the bottom of your posts. Moderating these posted comments can be done by editing/deleting posts in the GitHub Discussions section of your repository.
Leave a Comment