Browser docs

Docs Giscus Comments Engine

March 31, 2023 1 min read Modules Docs Comments Giscus
On this page

This module adds support for the Giscus comments engine, which powered by GitHub Discussions.

Modulegithub.com/hbstack/docs/modules/giscus
Repository⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
UsageSee how to use modules.

Site Parameters

ParameterTypeDefaultDescription
repostring-The GitHub repo name.
repo_idstring-The GitHub repo ID.
category_idstring-The GitHub discussions category ID.

Read more on How to Configure Giscus and Giscus Parameters.

params.toml

1[hb]
2  [hb.docs]
3    [hb.docs.giscus]
4      category_id = 'XXXXXXXXXXXXXXXXXXXX'
5      repo = 'user/site'
6      repo_id = 'XXXXXXXXXXXX'

params.yaml

1hb:
2  docs:
3    giscus:
4      category_id: XXXXXXXXXXXXXXXXXXXX
5      repo: user/site
6      repo_id: XXXXXXXXXXXX

params.json

 1{
 2   "hb": {
 3      "docs": {
 4         "giscus": {
 5            "category_id": "XXXXXXXXXXXXXXXXXXXX",
 6            "repo": "user/site",
 7            "repo_id": "XXXXXXXXXXXX"
 8         }
 9      }
10   }
11}