Files
cwd/docs/guide/frontend-config.md
anghunk 94653bfac8 docs(config): 重构配置文档结构并简化前端使用说明
- 删除 widget/CONFIG.md,将配置参数统一到 docs/guide/frontend-config.md
- 简化 widget/README.md,移除详细代码示例并指向完整文档链接
- 更新前端配置说明,优化注释并移除冗余参数
2026-01-14 13:31:16 +08:00

3.0 KiB
Raw Blame History

前端配置

这里仅提供一套开箱即用的方案,如果是个人开发者可以根据 API 文档自行编写前端评论组件。

接口 API

初始化

在初始化 CWDComments 实例时,可以传入以下配置参数:

<script src="https://cwd-comments.zishu.me/cwd-comments.js"></script>
<script>
  const comments = new CWDComments({
    el: '#comments', // 容器 id
    apiBaseUrl: 'https://your-api.example.com', // 你部署的api地址
    postSlug: 'my-post', // 当前页面路径,可使用博客程序支持的 url 模板路径
  });
  comments.mount();
</script>

参数说明

参数 类型 必填 默认值 说明
el string | HTMLElement - 挂载元素选择器或 DOM 元素
apiBaseUrl string - API 基础地址
postSlug string - 文章唯一标识符
postTitle string - 文章标题,用于邮件通知
postUrl string - 文章 URL用于邮件通知
theme 'light' | 'dark' 'light' 主题模式
pageSize number 20 每页显示评论数
avatarPrefix string https://gravatar.com/avatar 头像服务前缀
adminEmail string - 博主邮箱,用于显示博主标识
adminBadge string 博主 博主标识文字

头像服务前缀

常用的 Gravatar 镜像服务:

服务 前缀地址
Gravatar 官方 https://gravatar.com/avatar
Cravatar (国内) https://cravatar.cn/avatar
自定义镜像 https://your-mirror.com/avatar

实例方法

方法 说明
mount() 挂载组件到 DOM
unmount() 卸载组件
updateConfig(config) 更新配置(支持动态切换主题等)
getConfig() 获取当前配置

使用示例

// 动态切换主题
comments.updateConfig({ theme: 'dark' });

// 切换文章
comments.updateConfig({ postSlug: 'another-post' });