Goosequill 评论系统配置参数速查

作者:Goose 和 Quill
3 分钟阅读

目录

  1. 配置结构
  2. Giscus
  3. Waline
  4. 建议起步配置

Goosequill 目前通过 siteConfig.comments 支持两种评论提供方:

同一时间只应配置其中一种。

配置结构

在 src/config.ts 中设置 comments:

comments: {
provider: "giscus" | "waline",
}

Giscus

最小示例

comments: {
provider: "giscus",
repo: "owner/repo",
repoId: "R_kgDOExample",
category: "Announcements",
categoryId: "DIC_kwDOExample",
}

参数

参数类型必填默认值说明
provider"giscus"是—选择 Giscus
repostring是—GitHub 仓库,格式为 owner/name
repoIdstring是—Giscus 仓库 ID
categorystring是—GitHub Discussions 分类名
categoryIdstring是—GitHub Discussions 分类 ID
mapping"pathname" | "url" | "title" | "og:title" | "specific" | "number"否"pathname"页面与讨论串的映射方式
strict"0" | "1"否"0"是否严格匹配映射结果
reactionsEnabled"0" | "1"否"1"是否启用评论区反应表情
emitMetadata"0" | "1"否"0"是否输出讨论元数据
inputPosition"top" | "bottom"否"top"输入框位置
themestring否仅作兜底明暗主题共用的兜底主题名
theme_lightstring否"light"浅色模式下使用的 Giscus 主题
theme_darkstring否"dark"深色模式下使用的 Giscus 主题
langstring否"en"Giscus 界面语言
loading"lazy" | "eager"否"lazy"加载策略

说明

Waline

最小示例

comments: {
provider: "waline",
serverURL: "https://your-waline-server.example.com",
}

参数

参数类型必填默认值说明
provider"waline"是—选择 Waline
serverURLstring是—Waline 服务端地址
lang"zh" | "zh-CN" | "zh-TW" | "en" | "en-US" | "jp" | "jp-JP" | "pt-BR" | "ru" | "ru-RU" | "fr-FR" | "fr" | "vi" | "vi-vn" | "es" | "es-MX"否"en"Waline 界面语言
emojistring[] | false否false表情源列表,或关闭表情
meta("nick" | "mail" | "link")[]否["nick", "mail", "link"]表单里显示的字段
requiredMeta("nick" | "mail" | "link")[]否[]必填字段
login"enable" | "disable" | "force"否"enable"登录模式
wordLimitnumber | [number, number]否0评论字数限制
pageSizenumber否10每页评论数
searchboolean否false是否启用管理端搜索
reactionboolean | string[]否false是否启用反应,或自定义反应图片
pageviewboolean否false是否启用阅读量统计
noCopyrightboolean否false是否隐藏 Waline 版权信息
noRssboolean否false是否关闭 RSS 输出

说明

建议起步配置

如果你只想先跑起来: