Twikoo ---- [![](https://img.shields.io/npm/v/twikoo)](https://www.npmjs.com/package/twikoo) [![](https://img.shields.io/bundlephobia/minzip/twikoo)](https://bundlephobia.com/result?p=twikoo) [![](https://img.shields.io/npm/dt/twikoo)](https://www.npmjs.com/package/twikoo) [![](https://data.jsdelivr.com/v1/package/npm/twikoo/badge)](https://www.jsdelivr.com/package/npm/twikoo) [![](https://app.cloudback.it/badge/twikoojs/twikoo)](https://cloudback.it) [![](https://img.shields.io/npm/l/twikoo)](./LICENSE) 一个**简洁**、**安全**、**免费**的静态网站评论系统。
A **simple**, **safe**, **free** comment system. **简体中文** | [English](./README.en.md) ## 特色 | Features
点击展开 ### 简单 * 免费搭建（使用云开发 / Vercel / 私有部署评论后台） * 简单部署（支持云开发 / Vercel 一键部署） ### 易用 * 支持回复、点赞 * 无需额外适配，支持搭配浅色主题与深色主题使用 * 支持 API 调用，批量获取文章评论数、最新评论 * 访客在昵称栏输入 QQ 号，会自动补全 QQ 昵称和 QQ 邮箱 * 访客填写数字 QQ 邮箱，会使用 QQ 头像作为评论头像 * 支持评论框粘贴图片（可禁用） * 支持插入图片（可禁用） * 支持去不图床、云开发图床 * 支持插入表情（可禁用） * 支持 Ctrl + Enter 快捷回复 * 评论框内容实时保存草稿，刷新不会丢失 * [支持 Katex 公式](https://twikoo.js.org/faq.html#%E5%A6%82%E4%BD%95%E5%90%AF%E7%94%A8-katex-%E6%94%AF%E6%8C%81) * 支持按语言的代码高亮 ### 安全 * 隐私信息安全（通过云函数控制敏感字段（邮箱、IP、环境配置等）不会泄露） * 支持 Akismet 垃圾评论检测（需自行注册 [akismet.com](https://akismet.com/)） * 支持腾讯云内容安全垃圾评论检测（需自行注册 [腾讯云内容安全](https://console.cloud.tencent.com/cms/text/overview)） * 支持人工审核模式 * 防 XSS 注入 * 支持限制每个 IP 每 10 分钟最多发表多少条评论 ### 即时 * 支持邮件提醒（访客和博主） * 支持微信提醒（仅针对博主，基于 [Server酱](https://sc.ftqq.com/3.version)，需自行注册） * 支持 QQ 提醒（仅针对博主，基于 [Qmsg酱](https://qmsg.zendee.cn/)，需自行注册） ### 个性 * 支持自定义评论框背景图片 * 支持自定义“博主”标识文字 * 支持自定义通知邮件模板 * 支持自定义评论框提示信息（placeholder） * 支持自定义表情列表（兼容 [OwO 的数据格式](https://cdn.jsdelivr.net/npm/owo@1.0.2/demo/OwO.json)） * 支持自定义【昵称】【邮箱】【网址】必填 / 选填 * 支持自定义代码高亮主题 ### 便捷管理 * 内嵌式管理面板，通过密码登录，可方便地查看评论、隐藏评论、删除评论、修改配置 * 支持隐藏管理入口，通过输入暗号显示 * 支持从 Valine、Artalk、Disqus 导入评论 ### 缺点 * 不支持 IE
## 预览 | Preview
点击展开 ### 评论 ![评论](./docs/static/readme-1.png) ### 评论管理 ![评论管理](./docs/static/readme-2.png) ### 推送通知 ![推送通知](./docs/static/readme-3.jpg)
## 快速上手 | Quick Start 有关详细教程，请查看[快速上手](https://twikoo.js.org/quick-start.html)
如果你想获取更新动态、建言献策、参与测试，欢迎加入讨论群：1080829142 1080829142
## 特别感谢 | Special Thanks 图标设计：[Maemo Lee](https://www.maemo.cc) ## 开发 | Development 如果您想在本地二次开发，可以参考以下命令： ``` sh yarn dev # 开发 (http://localhost:9820/demo.html) yarn lint # 代码检查 yarn build # 编译 (dist/twikoo.all.min.js) ``` 如果您的改动能够帮助到更多人，欢迎提交 Pull Request！ ## 国际化 | I18N 支持简体中文、繁体中文、English。欢迎[提交翻译 PR](https://github.com/twikoojs/twikoo/edit/main/src/client/utils/i18n/i18n.js)。 ## 许可 | License
MIT License [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fimaegoo%2Ftwikoo.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fimaegoo%2Ftwikoo?ref=badge_large)