33 lines
1.8 KiB
Markdown
33 lines
1.8 KiB
Markdown
# GitHub comments plugin for Bludit
|
|
|
|
Add a comment section to your blog using utterances, an open source lightweight comments system built on GitHub issues. GitHub Comments is a plugging for [Bludit](https://www.bludit.com/). This plugin was modeled after the Disqus plugin for Bludit.
|
|
|
|
The plugin uses [Utterrrances](https://utteranc.es/) to manage the comments.
|
|
|
|
## Download
|
|
|
|
[Download the latest version.](https://github.com/algzb/github-comments-for-bludit/releases/tag/v1.0)
|
|
|
|
## How to install
|
|
|
|
1. Create an open GitHub repository.
|
|
2. Install the [Utterances App](https://github.com/apps/utterances) in your GitHub repository.
|
|
3. Download the last version of [GitHub Comments](https://github.com/algzb/github-comments-for-bludit/releases/tag/v1.0) and extract it in your **bl-plugins** directory.
|
|
4. Go to your Bludit admin panel and activate the GitHub Comments plugin.
|
|
5. Go to the pluging settings and enter your repository using the format **OWNER/REPO** . Do not add the url address and double check white spaces.
|
|
|
|
## Settings
|
|
|
|
| Setting | Default | Description |
|
|
|---|---|---|
|
|
| Repository | *(empty)* | GitHub repo in `OWNER/REPO` format. Comments are disabled until this is set. |
|
|
| Enable on pages | Enabled | Show comments on regular posts. |
|
|
| Enable on static pages | Enabled | Show comments on static pages. |
|
|
| Enable on sticky pages | Enabled | Show comments on sticky posts. |
|
|
| Follow site theme | Enabled | Reads the `blowdit-theme` cookie and selects `github-light` or `github-dark` automatically. Disable to pick a fixed theme below. |
|
|
| Theme | github-dark | Manual theme override (ignored when Follow site theme is on). |
|
|
|
|
## Demo and support
|
|
|
|
I'm using the plugin in my blog. [Check it out and leave a comment.](https://algzb.com/github-comments-plugin-for-bludit)
|