✨️ 复制成功,转载请标注本文地址

VitePress 集成 Giscus 评论插件

358 字
2 分钟
VitePress 集成 Giscus 评论插件

VitePress 集成 Giscus 评论插件#

前言#

笔者维护的 VitePress 博客主题 已经集成了非常多的功能,为便于在主题之外复用,因此有计划将其一部分功能分离出来,形成独立的插件。 分离的 Giscus 评论插件,效果如下: 不仅集成了 Giscus 评论系统,还包含了一个悬浮的评论跳转按钮(带移动端适配)。 接下来先简单介绍一下用法,再快速讲解核心原理。 插件开发基于之前创建的一个通用模板,vitepress-plugin-slot-inject-template,在模板的基础上,插件95%的代码由 Gemini 3.0 生成。

关于 Giscus#

Giscus 是一个基于 GitHub Discussions 的评论系统。它开源、免费、无广告、无跟踪,并且支持多种语言。 配置参数获取方式:

  • 访问 Giscus 官网

  • 按照页面提示配置你的仓库信息(确保仓库是公开的,并且安装了 Giscus App,且开启了 Discussions 功能)。

  • 在页面底部的“启用 giscus”部分,你会看到生成的一段 <script> 代码。

  • 将代码中的 data-repodata-repo-iddata-categorydata-category-id 等属性值对应填入插件配置即可。

如何使用#

只需要 2 步:

  • 安装插件
pnpm add vitepress-plugin-giscus @giscus/vue

1

  • 配置插件

在 .vitepress/config.ts 中引入插件:

import { defineConfig } from 'vitepress'
import { giscusPlugin } from 'vitepress-plugin-giscus'
export default defineConfig({
vite: {
plugins: [
giscusPlugin({
repo: 'your-github-username/your-repo-name',
repoId: 'your-repo-id',
category: 'Announcements',
categoryId: 'your-category-id',
mapping: 'pathname',
// ...其他 giscus 配置
})
]
}
})

支持与分享

如果这篇文章对你有帮助,欢迎分享给更多人或打赏支持!

打赏
VitePress 集成 Giscus 评论插件
https://blog.z2m.store/posts/discuss/
作者
深漂小鱼
发布于
2026-08-11
许可协议
CC BY-NC-SA 4.0

评论区

Profile Image of the Author
深漂小鱼
扫码关注公众号
公告
欢迎来到我的博客!点击上方中间按钮可直接进入聊天室。
统计
分类
标签
最新动态
站点统计
文章
42
分类
4
标签
14
总字数
72,969
运行时长
0
最后活动
0 天前
--%
本年还剩 -- 天
--%
本月还剩 -- 天
--%
本周还剩 -- 天

距离 --

--

--

站点信息
构建平台
Cloudflare Pages
博客版本
Firefly v6.15.0
文章许可
CC BY-NC-SA 4.0
工具