Remark42 是一个**轻量级、快速且安全**的开源评论系统，可以轻松嵌入到任何网站中。 ### 核心功能 - ✅ **多种 OAuth 认证**：支持 GitHub、Google、Facebook、Twitter、Yandex 等 - ✅ **Markdown 支持**：完整的 Markdown 格式化功能 - ✅ **图片上传**：支持评论中上传图片 - ✅ **投票系统**：支持点赞/踩评论 - ✅ **评论审核**：管理员可以审核、编辑、删除评论 - ✅ **匿名评论**：可选启用匿名评论功能 - ✅ **多语言支持**：支持中文、英文等多种语言 - ✅ **响应式设计**：完美适配桌面和移动设备 - ✅ **数据导入导出**：支持备份和迁移 - ✅ **评论通知**：可配置邮件和 Telegram 通知 ### 1. 访问演示页面 安装应用后，直接访问你的应用域名即可看到演示页面： ``` https://你的应用域名/ ``` 演示页面包含： - **评论组件演示** - 页面下方完整的评论系统 - **最新评论小部件** - 显示最新的评论列表 - **评论计数器** - 显示评论数量 - **主题切换** - 明暗主题切换功能 ### 2. 配置 OAuth 认证（必需） 要让用户能够登录和发表评论，**必须至少配置一个 OAuth 提供商**。 #### 最简单：使用 GitHub OAuth 1. **访问 GitHub 创建 OAuth App**： - 登录 GitHub - 访问 https://github.com/settings/developers - 点击 "New OAuth App" 2. **填写应用信息**： ``` Application name: Remark42 评论系统 Homepage URL: https://你的应用域名/ Authorization callback URL: https://你的应用域名/auth/github/callback ``` 3. **获取凭证**： - 创建后会得到 `Client ID` 和 `Client Secret` - 保存这两个值 4. **配置到懒猫微服**： 通过懒猫微服控制台或 CLI 设置环境变量： ```bash # 使用 CLI lzc-cli app env set <app-id> AUTH_GITHUB_CID=你的Client_ID lzc-cli app env set <app-id> AUTH_GITHUB_CSEC=你的Client_Secret ``` 或在控制台的应用环境变量中添加： ``` AUTH_GITHUB_CID = 你的Client_ID AUTH_GITHUB_CSEC = 你的Client_Secret ``` 5. **重启应用**： ```bash lzc-cli app restart <app-id> ``` 完成后，用户就可以使用 GitHub 账号登录和评论了！ ## 嵌入到你的网站 ### 基本嵌入代码 在你的网站页面中添加以下代码，即可显示 Remark42 评论组件： ```html <!-- 第一步：添加评论容器 --> <div id="remark42"></div> <!-- 第二步：添加配置和加载脚本 --> <script> var remark_config = { host: 'https://你的应用域名', site_id: 'remark', components: ['embed'], }; (function(c, d) { for (var i = 0; i < c.length; i++) { var s = d.createElement('script'); s.src = remark_config.host + '/web/' + c[i] + '.js'; s.async = true; s.defer = true; (d.head || d.body).appendChild(s); } })(remark_config.components || ['embed'], document); </script> ``` ### 获取最新评论 ```bash GET https://你的应用域名/api/v1/last/10?site=remark ``` ### 获取评论数量 ```bash # 单个 URL GET https://你的应用域名/api/v1/count?site=remark&url=文章URL # 多个 URL POST https://你的应用域名/api/v1/counts?site=remark Content-Type: application/json ["URL1", "URL2", "URL3"] ``` ### 发表评论（需要认证） ```bash POST https://你的应用域名/api/v1/comment Content-Type: application/json Authorization: Bearer JWT_TOKEN { "text": "评论内容", "locator": { "site": "remark", "url": "文章URL" } } ``` ### 管理员 API（需要管理员权限） ```bash # 删除评论 DELETE https://你的应用域名/api/v1/admin/comment/{comment_id}?site=remark Authorization: Bearer JWT_TOKEN # 导出数据 GET https://你的应用域名/api/v1/admin/export?site=remark&mode=full Authorization: Bearer JWT_TOKEN ```