Skip to content

Feature Request: Add Built-in Comment Section Support for Documentation Pages #5057

@zhh2001

Description

@zhh2001

Is your feature request related to a problem? Please describe.

VitePress-powered static documentation sites currently lack interactive capabilities for reader communication.

Describe the solution you'd like

I propose adding an optional built-in comment section feature with the following design:

  1. Provide a simple configuration option in <root>/.vitepress/config.[ext] to enable/disable comments globally or per page.
  2. Integrate popular lightweight comment engines (Giscus, Twikoo) as optional providers, with default configurations for quick setup.
  3. Support automatic theme adaptation (light/dark mode) and placement control (e.g., after document content).

Describe alternatives you've considered

  1. Manual integration of third-party comment tools: Requires customizing theme layouts and handling edge cases like route transitions, which increases maintenance overhead.
  2. Building a custom comment component: Duplicates existing mature solutions and risks compatibility issues with future VitePress updates.

Additional context

Comment sections are essential for technical documentation and blogs, as they facilitate knowledge sharing, feedback collection, and community building. Many similar static site generators (e.g., VuePress with comment plugins) already offer this capability, which has become a user expectation for interactive content. A native solution would streamline the workflow for VitePress users while maintaining the tool's simplicity and performance advantages.

Validations

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions