Giscus Options

Less than 1 minute

repo

  • Type: string
  • Required: No

The name of repository to store discussions.

repoId

  • Type: string
  • Required: No

The ID of repository to store discussions. Generate through Giscus Pageopen in new window

category

  • Type: string
  • Required: No

The name of the discussion category.

categoryId

  • Type: string
  • Required: No

The ID of the discussion category. Generate through Giscus Pageopen in new window

mapping

  • Type: string
  • Default: "pathname"

Page - Discussion mapping. For details see Giscus Pageopen in new window

strict

  • Type: boolean
  • Default: true

Whether enable strict mapping or not

lazyLoading

  • Type: boolean
  • Default: true

Whether enable lazy loading or not

reactionsEnabled

  • Type: boolean
  • Default: true

Whether enable reactions or not

inputPosition

  • Type: "top" | "bottom"
  • Default: "top"

Input position

lightTheme

  • Type: GiscusTheme

    type GiscusTheme =
      | "light"
      | "light_high_contrast"
      | "light_protanopia"
      | "dark"
      | "dark_high_contrast"
      | "dark_protanopia"
      | "dark_dimmed"
      | "transparent_dark"
      | "preferred_color_scheme"
      | `https://${string}`;
    
  • Default: "light"

Giscus theme used in lightmode

Should be a built-in theme keyword or a css link starting with https://.

darkTheme

  • Type: GiscusTheme

    type GiscusTheme =
      | "light"
      | "light_high_contrast"
      | "light_protanopia"
      | "dark"
      | "dark_high_contrast"
      | "dark_protanopia"
      | "dark_dimmed"
      | "transparent_dark"
      | "preferred_color_scheme"
      | `https://${string}`;
    
  • Default: "dark"

Giscus theme used in darkmode

Should be a built-in theme keyword or a css link starting with https://.

Loading...