|
12 | 12 | [](https://codecov.io/gh/ArtalkJS/Artalk)
|
13 | 13 | [](https://bundlephobia.com/package/artalk)
|
14 | 14 |
|
15 |
| -[English](./README.en.md) • [官方网站](https://artalk.js.org) • [最新版本](https://github.com/ArtalkJS/Artalk/releases) • [更新日志](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md) |
| 15 | +[Homepage](https://artalk.js.org) • [Documentation](https://artalk.js.org/en/guide/deploy.html) • [Latest Release](https://github.com/ArtalkJS/Artalk/releases) • [Changelog](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md) • [简体中文](./README.zh.md) |
16 | 16 |
|
17 |
| -Artalk 是一款简单易用但功能丰富的评论系统,你可以开箱即用地部署并置入任何博客、网站、Web 应用。 |
| 17 | +Artalk is an intuitive yet feature-rich comment system, ready for immediate deployment into any blog, website, or web application. |
18 | 18 |
|
19 |
| -- 🍃 前端 ~40KB,纯天然 Vanilla JS |
20 |
| -- 🍱 后端 Golang,高效轻量跨平台 |
21 |
| -- 🐳 通过 Docker 一键部署,方便快捷 |
22 |
| -- 🌈 开源程序,自托管,隐私至上 |
| 19 | +- 🍃 Client ~40KB, crafted with pure Vanilla JS, framework-agnostic |
| 20 | +- 🍱 Server powered by Golang, offering efficient and lightweight cross-platform performance |
| 21 | +- 🐳 One-click deployment via Docker, ensuring ease and speed |
| 22 | +- 🌈 Open-source software, self-hosted with privacy as a priority |
23 | 23 |
|
24 |
| -## 特性 |
| 24 | +## Features |
25 | 25 |
|
26 | 26 | <!-- prettier-ignore-start -->
|
27 | 27 |
|
28 | 28 | <!-- features -->
|
29 |
| -* [侧边栏](https://artalk.js.org/guide/frontend/sidebar.html): 快速管理、直观浏览 |
30 |
| -* [社交登录](https://artalk.js.org/guide/frontend/auth.html): 通过社交账号快速登录 |
31 |
| -* [邮件通知](https://artalk.js.org/guide/backend/email.html): 多种发送方式、邮件模板 |
32 |
| -* [多元推送](https://artalk.js.org/guide/backend/admin_notify.html): 多种推送方式、通知模版 |
33 |
| -* [站内通知](https://artalk.js.org/guide/frontend/sidebar.html): 红点标记、提及列表 |
34 |
| -* [验证码](https://artalk.js.org/guide/backend/captcha.html): 多种验证类型、频率限制 |
35 |
| -* [评论审核](https://artalk.js.org/guide/backend/moderator.html): 内容检测、垃圾拦截 |
36 |
| -* [图片上传](https://artalk.js.org/guide/backend/img-upload.html): 自定义上传、支持图床 |
37 |
| -* [Markdown](https://artalk.js.org/guide/intro.html): 支持 Markdown 语法 |
38 |
| -* [表情包](https://artalk.js.org/guide/frontend/emoticons.html): 兼容 OwO,快速集成 |
39 |
| -* [多站点](https://artalk.js.org/guide/backend/multi-site.html): 站点隔离、集中管理 |
40 |
| -* [管理员](https://artalk.js.org/guide/backend/multi-site.html): 密码验证、徽章标识 |
41 |
| -* [页面管理](https://artalk.js.org/guide/frontend/sidebar.html): 快速查看、标题一键跳转 |
42 |
| -* [浏览量统计](https://artalk.js.org/guide/frontend/pv.html): 轻松统计网页浏览量 |
43 |
| -* [层级结构](https://artalk.js.org/guide/frontend/config.html#nestmax): 嵌套分页列表、滚动加载 |
44 |
| -* [评论投票](https://artalk.js.org/guide/frontend/config.html#vote): 赞同或反对评论 |
45 |
| -* [评论排序](https://artalk.js.org/guide/frontend/config.html#listsort): 多种排序方式,自由选择 |
46 |
| -* [评论搜索](https://artalk.js.org/guide/frontend/sidebar.html): 快速搜索评论内容 |
47 |
| -* [评论置顶](https://artalk.js.org/guide/frontend/sidebar.html): 重要消息置顶显示 |
48 |
| -* [仅看作者](https://artalk.js.org/guide/frontend/config.html): 仅显示作者的评论 |
49 |
| -* [评论跳转](https://artalk.js.org/guide/intro.html): 快速跳转到引用的评论 |
50 |
| -* [自动保存](https://artalk.js.org/guide/frontend/config.html): 输入内容防丢功能 |
51 |
| -* [IP 属地](https://artalk.js.org/guide/frontend/ip-region.html): 用户 IP 属地展示 |
52 |
| -* [数据迁移](https://artalk.js.org/guide/transfer.html): 自由迁移、快速备份 |
53 |
| -* [图片灯箱](https://artalk.js.org/guide/frontend/lightbox.html): 图片灯箱快速集成 |
54 |
| -* [图片懒加载](https://artalk.js.org/guide/frontend/img-lazy-load.html): 延迟加载图片,优化体验 |
55 |
| -* [Latex](https://artalk.js.org/guide/frontend/latex.html): Latex 公式解析集成 |
56 |
| -* [夜间模式](https://artalk.js.org/guide/frontend/config.html#darkmode): 夜间模式切换 |
57 |
| -* [扩展插件](https://artalk.js.org/develop/plugin.html): 创造更多可能性 |
58 |
| -* [多语言](https://artalk.js.org/guide/frontend/i18n.html): 多国语言切换 |
59 |
| -* [命令行](https://artalk.js.org/guide/backend/config.html): 命令行操作管理能力 |
60 |
| -* [API 文档](https://artalk.js.org/http-api.html): 提供 OpenAPI 格式文档 |
61 |
| -* [程序升级](https://artalk.js.org/guide/backend/update.html): 版本检测,一键升级 |
| 29 | +* [Sidebar](https://artalk.js.org/guide/frontend/sidebar.html): Quick management, intuitive browsing |
| 30 | +* [Social Login](https://artalk.js.org/guide/frontend/auth.html): Fast login via social accounts |
| 31 | +* [Email Notification](https://artalk.js.org/guide/backend/email.html): Various sending methods, email templates |
| 32 | +* [Diverse Push](https://artalk.js.org/guide/backend/admin_notify.html): Multiple push methods, notification templates |
| 33 | +* [Site Notification](https://artalk.js.org/guide/frontend/sidebar.html): Red dot marks, mention list |
| 34 | +* [Captcha](https://artalk.js.org/guide/backend/captcha.html): Various verification types, frequency limits |
| 35 | +* [Comment Moderation](https://artalk.js.org/guide/backend/moderator.html): Content detection, spam interception |
| 36 | +* [Image Upload](https://artalk.js.org/guide/backend/img-upload.html): Custom upload, supports image hosting |
| 37 | +* [Markdown](https://artalk.js.org/guide/intro.html): Supports Markdown syntax |
| 38 | +* [Emoji Pack](https://artalk.js.org/guide/frontend/emoticons.html): Compatible with OwO, quick integration |
| 39 | +* [Multi-Site](https://artalk.js.org/guide/backend/multi-site.html): Site isolation, centralized management |
| 40 | +* [Admin](https://artalk.js.org/guide/backend/multi-site.html): Password verification, badge identification |
| 41 | +* [Page Management](https://artalk.js.org/guide/frontend/sidebar.html): Quick view, one-click title navigation |
| 42 | +* [Page View Statistics](https://artalk.js.org/guide/frontend/pv.html): Easily track page views |
| 43 | +* [Hierarchical Structure](https://artalk.js.org/guide/frontend/config.html#nestmax): Nested paginated list, infinite scroll |
| 44 | +* [Comment Voting](https://artalk.js.org/guide/frontend/config.html#vote): Upvote or downvote comments |
| 45 | +* [Comment Sorting](https://artalk.js.org/guide/frontend/config.html#listsort): Various sorting options, freely selectable |
| 46 | +* [Comment Search](https://artalk.js.org/guide/frontend/sidebar.html): Quick comment content search |
| 47 | +* [Comment Pinning](https://artalk.js.org/guide/frontend/sidebar.html): Pin important messages |
| 48 | +* [View Author Only](https://artalk.js.org/guide/frontend/config.html): Show only the author's comments |
| 49 | +* [Comment Jump](https://artalk.js.org/guide/intro.html): Quickly jump to quoted comment |
| 50 | +* [Auto Save](https://artalk.js.org/guide/frontend/config.html): Content loss prevention |
| 51 | +* [IP Region](https://artalk.js.org/guide/frontend/ip-region.html): Display user's IP region |
| 52 | +* [Data Migration](https://artalk.js.org/guide/transfer.html): Free migration, quick backup |
| 53 | +* [Image Lightbox](https://artalk.js.org/guide/frontend/lightbox.html): Quick integration of image lightbox |
| 54 | +* [Image Lazy Load](https://artalk.js.org/guide/frontend/img-lazy-load.html): Lazy load images, optimize experience |
| 55 | +* [Latex](https://artalk.js.org/guide/frontend/latex.html): Integrate Latex formula parsing |
| 56 | +* [Night Mode](https://artalk.js.org/guide/frontend/config.html#darkmode): Switch to night mode |
| 57 | +* [Extension Plugin](https://artalk.js.org/develop/plugin.html): Create more possibilities |
| 58 | +* [Multi-Language](https://artalk.js.org/guide/frontend/i18n.html): Switch between multiple languages |
| 59 | +* [Command Line](https://artalk.js.org/guide/backend/config.html): Command line operation management |
| 60 | +* [API Documentation](https://artalk.js.org/http-api.html): Provides OpenAPI format documentation |
| 61 | +* [Program Upgrade](https://artalk.js.org/guide/backend/update.html): Version check, one-click upgrade |
62 | 62 | <!-- /features -->
|
63 | 63 |
|
64 | 64 | <!-- prettier-ignore-end -->
|
65 | 65 |
|
66 |
| -## 安装 |
| 66 | +## Installation |
67 | 67 |
|
68 |
| -通过 Docker 一键部署: |
| 68 | +Deploy with Docker in one step: |
69 | 69 |
|
70 | 70 | ```bash
|
71 | 71 | docker run -d \
|
72 | 72 | --name artalk \
|
73 | 73 | -p 8080:23366 \
|
74 | 74 | -v $(pwd)/data:/data \
|
75 |
| - -e "TZ=Asia/Shanghai" \ |
76 |
| - -e "ATK_LOCALE=zh-CN" \ |
77 |
| - -e "ATK_SITE_DEFAULT=Artalk 的博客" \ |
| 75 | + -e "TZ=America/New_York" \ |
| 76 | + -e "ATK_LOCALE=en" \ |
| 77 | + -e "ATK_SITE_DEFAULT=Artalk Blog" \ |
78 | 78 | -e "ATK_SITE_URL=https://example.com" \
|
79 | 79 | artalk/artalk-go
|
80 | 80 | ```
|
81 | 81 |
|
82 |
| -在网页中引入 Artalk: |
| 82 | +Integrate Artalk into your webpage: |
83 | 83 |
|
84 | 84 | <!-- prettier-ignore-start -->
|
85 | 85 |
|
86 | 86 | ```ts
|
87 | 87 | Artalk.init({
|
88 | 88 | el: '#Comments',
|
89 |
| - site: 'Artalk 的博客', |
| 89 | + site: 'Artalk Blog', |
90 | 90 | server: 'https://artalk.example.com',
|
91 | 91 | pageKey: '/2018/10/02/hello-world.html'
|
92 | 92 | })
|
93 | 93 | ```
|
94 | 94 |
|
95 | 95 | <!-- prettier-ignore-end -->
|
96 | 96 |
|
97 |
| -[**了解更多 →**](https://artalk.js.org/guide/deploy.html) |
| 97 | +[**Learn More →**](https://artalk.js.org/guide/deploy.html) |
98 | 98 |
|
99 | 99 | ## For Developers
|
100 | 100 |
|
|
0 commit comments