https://github.com/ddev/giscus-comments
Repository for storing comments via giscus
https://github.com/ddev/giscus-comments
Last synced: 5 months ago
JSON representation
Repository for storing comments via giscus
- Host: GitHub
- URL: https://github.com/ddev/giscus-comments
- Owner: ddev
- License: apache-2.0
- Created: 2025-02-13T21:51:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-17T19:59:57.000Z (over 1 year ago)
- Last Synced: 2025-12-22T07:43:38.139Z (6 months ago)
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DDEV giscus-comments
This repository uses GitHub Discussions to store user comments via giscus.
## Moderation
To moderate comments, visit the [Discussions](https://github.com/ddev/giscus-comments/discussions) page, where you can filter by category.
## How to integrate giscus with your website
1. Choose the repository
Ensure that the repository giscus will connect to meets the following requirements (This has already been done for `ddev/giscus-comments`):
- The repository is [public](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/setting-repository-visibility#making-a-repository-public), otherwise visitors will not be able to view the discussion.
- The [giscus](https://github.com/apps/giscus) app is installed, otherwise visitors will not be able to comment and react.
- The Discussions feature is turned on by [enabling it for your repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository).
2. Create a discussion category
[Create a new category](https://github.com/ddev/giscus-comments/discussions/categories/new) with:
- A meaningful name
- A description that explains how the comments will relate to the repository
- The format set to `Open-ended discussion`
3. Generate the giscus script
Visit [giscus.app](https://giscus.app/) and configure:
- **Repository**: `ddev/giscus-comments`
- **Page ↔️ Discussions Mapping**: Select "Discussion title contains page ``"
- **Discussion Category**: Choose the category created in step 2
- **Features**:
- Enable reactions for the main post
- Place the comment box above the comments
- Lazy-load the comments
- **Theme**: If your site supports automatic light/dark mode, choose `Preferred color scheme`.
4. Embed the script to your website
For example, the following script is used for the [ddev/addon-registry](https://github.com/ddev/addon-registry):
```js
```
5. Enjoy with new comments integration