The Wayback Machine - https://web.archive.org/web/20211022172113/https://github.com/ArtalkJS/Artalk
Skip to content
master
Switch branches/tags
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Artalk

Artalk

🌌 一款简洁的自托管评论系统 | A Selfhosted Comment System.

官网前往 | 文档细节

  • 轻量 (~30kB gzipped)
  • 自托管 (隐私安全)
  • 简单易上手 (防秃顶)
  • Markdown 语法 (通用性)
  • Golang 后端 (易部署 / 跨平台)

特色功能

  • 表 情 包 :统一管理 / 链接替换
  • 通知中心:红点标记 / 已读记录
  • 身份验证:徽标自定义 / 密码验证
  • 站点隔离:多站点管理 / 站点管理员用户分配
  • 评论审核:反垃圾检测 / 验证码 / 提交频率限制
  • 邮件提醒:模版自定义 / 多管理员通知
  • 树洞模式:仅自己可见 / 说说功能
  • 页面管理:标题可显示 / 快速跳转
  • 无限层级:可切换为 “平铺模式”
  • 评论投票:赞同还是反对评论
  • 异步处理:邮件发送无需等待
  • 滚动加载:评论内容分页处置
  • 自动保存:用户输入防丢功能
  • 自动填充:用户链接自动填充
  • 暗黑模式:防止眼部疾病伤害
  • 评论折叠:这个不打算给你康
  • 数据备份:防止评论数据丢失
  • 数据迁移:在不同评论系统之间来回切换
  • 一页多评:一页多个评论区(似乎没啥用
  • TypeScript & Vanilla:纯天然无添加 / 无需依赖
  • Vite:开发者的极致体验

基本食用方针

两步抵达

  1. 后端程序部署:ArtalkGo
  2. 前端页面引入:
<!DOCTYPE html>
<html>
<head>

  <!-- 引入 CSS -->
  <link href="https://cdn.jsdelivr.net/npm/artalk@2/dist/Artalk.css" rel="stylesheet">

</head>
<body>

  <!-- 给定元素 -->
  <div id="ArtalkComments"></div>

  <!-- 引入 JS -->
  <script src="https://cdn.jsdelivr.net/npm/artalk@2/dist/Artalk.umd.js"></script>

  <!-- 配置 Artalk -->
  <script>
  new Artalk({
    el:          '#ArtalkComments',
    placeholder: '说点什么 (づ ̄ 3 ̄)づ',
    noComment:   '此时无声胜有声',
    pageKey:     '',   // 页面链接 (填写一个页面的完整 URL)
    pageTitle:   '',   // 页面标题 (用于后台列表显示)
    server:      '',   // 后端程序 (填写后端程序完整 URL;例如:https://domain/api)
    site:        '',   // 站点名称(用于站点隔离,留空使用默认站点)
  })
  </script>

</body>
</html>

更多细节请 查阅文档

CDN 资源

在页面合适的位置通过 CDN 资源引入 Artalk:

<!-- CSS -->
<link href="https://cdn.jsdelivr.net/npm/artalk@2/dist/Artalk.css" rel="stylesheet">

<!-- JS -->
<script src="https://cdn.jsdelivr.net/npm/artalk@2/dist/Artalk.umd.js"></script>

NPM 引用

$ yarn add artalk
import Artalk from 'artalk'

new Artalk({
  // ...your configs
})

Artalk 拥有 TypeScript 声明文件,能够在引用时帮助您进行代码提示。

特别致谢

感谢社区提供的帮助与反馈,若有好的建议与意见欢迎前往 issues 随时告知。

Stargazers over time

Stargazers over time FOSSA Status

License

GPL-3.0

FOSSA Status