Skip to content

Commit

Permalink
chore(docs): refine some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qwqcode committed Jun 19, 2024
1 parent 1337e81 commit 4d9445c
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 6 deletions.
9 changes: 8 additions & 1 deletion README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,14 @@
Deploy via Docker with one click:

```bash
docker run -d --name artalk -p 8080:23366 -v $(pwd)/data:/data artalk/artalk-go
docker run -d \
--name artalk \
-p 8080:23366 \
-v $(pwd)/data:/data \
-e ATK_LOCALE="en" \
-e ATK_SITE_DEFAULT="Artalk Blog" \
-e ATK_TRUSTED_DOMAINS="https://your_domain" \
artalk/artalk-go
```

Integrate Artalk into your webpage:
Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,14 @@ Artalk 是一款简单易用但功能丰富的评论系统,你可以开箱即
通过 Docker 一键部署:

```bash
docker run -d --name artalk -p 8080:23366 -v $(pwd)/data:/data artalk/artalk-go
docker run -d \
--name artalk \
-p 8080:23366 \
-v $(pwd)/data:/data \
-e ATK_LOCALE="zh-CN" \
-e ATK_SITE_DEFAULT="Artalk 的博客" \
-e ATK_TRUSTED_DOMAINS="https://your_domain" \
artalk/artalk-go
```

在网页中引入 Artalk:
Expand Down
1 change: 1 addition & 0 deletions docs/docs/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

**其他内容**

- [兼容性](../develop/compatibility.md)
- [更新日志](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md)
- [i18n 多语言贡献指南](../guide/frontend/i18n.md#贡献翻译)
- [贡献者契约行为准则](https://github.com/ArtalkJS/Artalk/blob/master/CODE_OF_CONDUCT.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,12 @@ Artalk.init({
**compose.yaml**

```yaml
version: '3.5'
version: '3.8'
services:
artalk:
container_name: artalk
image: artalk/artalk-go
restart: always
restart: unless-stopped
ports:
- 8080:23366
volumes:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/guide/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ artalk config
使用 Docker Compose 部署 Artalk,可在 `compose.yml` 文件添加环境变量,例如:

```yaml
version: '3.5'
version: '3.8'
services:
artalk:
container_name: artalk
image: artalk/artalk-go
restart: always
restart: unless-stopped
ports:
- 8080:23366
volumes:
Expand Down

0 comments on commit 4d9445c

Please sign in to comment.