For full text search please use the '?' prefix. e.g. ? Onboarding

giscus

All required fields in this configuration namespace can be generated through the configuration tool

To learn more about Giscus, please refer to Giscus

Summary

Configuration namepsace that holds all Giscus related publishing settings.

Below is an overview of what the giscus namespace looks like:

publishing:
  giscus:
    id:
    host:
    repo:
    repoId:
    category:
    categoryId:
    mapping:
    term:
    theme:
    strict:
    reactionsEnabled:
    emitMetadata:
    inputPosition:
    lang:
    loading:

id

From Id
Go to text →
  • type: string
  • default: N/A
  • required: false

Description

Set the id of the Giscus component.

Example

  publishing:
    giscus:
      id: comments

host

From Host
Go to text →

This is only required if you wish to self-host Giscus.
Remove this configuration from dendron.yml if you are not self hosting.

  • type: string
  • default: N/A
  • required: false

Description

Host of the Giscus server.

Example

  publishing:
    giscus:
      host: my-custom-host.com

repo

From Repo
Go to text →

The string should be formatted in the following form:
{user name}/{repo name} for personal repositories {organization name}/{repo name} for organization repositories

  • type: ${string}/${string}
  • default: N/A
  • required: true

Descroption

Repository where the discussion is stored..

Example

  publishing:
    giscus:
      repo: "dendronhq/dendron-site"

repoId

From repoId
Go to text →

Please use the configuration tool to figure out your repository ID.
When you select your public repository from the tool, the ID will be automatically generated.

  • type: string
  • default: N/A
  • required: true

Description

ID of the repository where the discussion is stored

Example

  publishing:
    giscus:
      repoId: "1234567890"

category

From Category
Go to text →
  • type: string
  • default: N/A
  • required: false

Description

Category where the discussion will be searched

Example

  publishing:
    giscus:
      category: "Announcements"

categoryId

From categoryId
Go to text →

Please use the configuration tool to figure out your category ID.
When you select your public repository from the tool, you will be given a dropdown of available Github Discussions categories in your repository.
When you select the category from the dropdown, the category ID will be automatically be generated.

  • type: string
  • default: N/A
  • required: false

Description

ID of the category where the discussion will be searched.

Example

  publishing:
    giscus:
      categoryId: "1234567890"

mapping

From Mapping
Go to text →
  • type: url | title | og:title | specific | number | pathname
  • default: N/A
  • required: true

Description

Set the mapping between the parent page and the discussion.

Example

  publishing:
    giscus:
      mapping: "pathname"

term

From Term
Go to text →

⚠️ Due to limitations, this configuration currently has no effect when publishing your notes with Dendron.

  • type: string
  • default: N/A
  • required: false

Description

Search term to use when searching for the discussion

Example

  publishing:
    giscus:
      term: "term"

theme

From Theme
Go to text →

⚠️ Due to limitations, experimental custom theme support is limited when publishing your notes with Dendron.
Only the provided themes are supported.

  • type: | light | light_high_contrast | light_protanopia | light_tritanopia | dark | dark_high_contrast | dark_protanopia | dark_tritanopia | dark_dimmed | transparent_dark | preferred_color_scheme
  • default: N/A
  • required: false

Description

Theme that Giscus will be displayed in.

Example

  publishing:
    giscus:
      theme: preferred_color_scheme

strict

From Strict
Go to text →
  • type: 0 | 1
  • default: N/A
  • required: false

Description

Use strict title matching.

Example

  publishing:
    giscus:
      strict: "0"

reactionsEnabled

From reactionsEnabled
Go to text →
  • type: 0 | 1
  • default: N/A
  • required: false

Description

Enable reactions to the main post of the discussion.

Example

  publishing:
    giscus:
      reactionsEnabled: "1"

emitMetadata

From emitMetadata
Go to text →
  • type: 0 | 1
  • default: N/A
  • required: false

Description

Emit the discussion metadata periodically to the parent page.

Example

  publishing:
    giscus:
      emitMetadata: "0"

inputPosition

From inputPosition
Go to text →
  • type: top | bottom
  • default: N/A
  • required: true

Description

Placement of the comment box.

Example

  publishing:
    giscus:
      inputPosition: "top"

lang

From Lang
Go to text →
  • type: | de | gsw | en | es | fr | id | it | ja | ko | nl | pl | pt | ro | ru | tr | vi | zh-CN | zh-TW
  • default: N/A
  • required: false

Description

Language that Giscus will be displayed in.

Example

  publishing:
    giscus:
      lang: "en"

loading

From Loading
Go to text →
  • type: lazy | eager
  • default: N/A
  • required: false

Description

Whether the iframe should be loaded lazily or eagerly.

Example

  publishing:
    giscus:
      loading: "lazy"

Backlinks