@karaoke-cms/module-comments

Giscus comments module for karaoke-cms. Embeds GitHub Discussion threads on blog posts and docs pages.

Installation

pnpm add @karaoke-cms/module-comments

Usage

// karaoke.config.ts
import { defineConfig } from '@karaoke-cms/astro';
import { comments } from '@karaoke-cms/module-comments';

export default defineConfig({
  modules: [
    comments({
      repo: 'owner/repo',
      repoId: 'R_...',
      category: 'General',
      categoryId: 'DIC_...',
    }),
  ],
});

Get repoId and categoryId from giscus.app after enabling GitHub Discussions on your repository.

Per-post override

Individual posts and docs can disable comments via frontmatter:

---
title: My Post
comments: false
---

CSS contract

Themes must implement the .comments class:

| Class | Description | Required | |-------|-------------|----------| | comments | Comments section wrapper (Giscus embed) | Yes |