Skip to content

Commit

Permalink
docs(hugo): v0.13.1
Browse files Browse the repository at this point in the history
  • Loading branch information
iyear committed Dec 4, 2023
1 parent f68ac3c commit 969d44a
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 29 deletions.
12 changes: 6 additions & 6 deletions docs/content/en/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ weight: 10
#### Install latest version

{{< command >}}
iwr -useb https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1 | iex
iwr -useb https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1 | iex
{{< /command >}}

#### Install with `ghproxy.com`

{{< command >}}
$Script=iwr -useb https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Script=iwr -useb https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -ArgumentList "", "$True"
{{< /command >}}

#### Install specific version

{{< command >}}
$Env:TDLVersion = "VERSION"
$Script=iwr -useb https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Script=iwr -useb https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -ArgumentList "$Env:TDLVersion"
{{< /command >}}

Expand All @@ -42,19 +42,19 @@ $Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -Argum
#### Install latest version

{{< command >}}
curl -sSL https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash
curl -sSL https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash
{{< /command >}}

#### Install with `ghproxy.com`

{{< command >}}
curl -sSL https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --proxy
curl -sSL https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --proxy
{{< /command >}}

#### Install specific version

{{< command >}}
curl -sSL https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --version VERSION
curl -sSL https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --version VERSION
{{< /command >}}

{{< /tab >}}
Expand Down
10 changes: 6 additions & 4 deletions docs/content/en/guide/global-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ tdl -n iyear

## `--proxy`

Set the proxy. Only support `socks5` now. Default: `""`.
Set the proxy. Default: `""`.

Format: `protocol://username:password@host:port`

{{< command >}}
tdl --proxy socks5://localhost:1080
tdl --proxy http://localhost:8080
tdl --proxy https://localhost:8081
{{< /command >}}

## `--ntp`
Expand Down Expand Up @@ -57,10 +59,10 @@ tdl --debug

## `--pool`

Set the DC pool size of Telegram client. Default: `3`.
Set the DC pool size of Telegram client. Default: `8`.

{{< hint warning >}}
DO NOT set it too large, or tdl may be forced to quit by Telegram.
{{< hint info >}}
Set higher timeout or 0(INF) if you want faster speed.
{{< /hint >}}

{{< command >}}
Expand Down
8 changes: 4 additions & 4 deletions docs/content/en/guide/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Backup or recover your data

## Backup

Backup your data to a zip file. Default: `tdl-backup-<time>.zip`.
Backup your data to a file. Default: `<date>.backup.tdl`.

{{< command >}}
tdl backup
Expand All @@ -18,13 +18,13 @@ tdl backup
Or specify the output file:

{{< command >}}
tdl backup -d /path/to/backup.zip
tdl backup -d /path/to/custom.tdl
{{< /command >}}

## Recover

Recover your data from a zip file.
Recover your data from a tdl backup file.

{{< command >}}
tdl recover -f /path/to/backup.zip
tdl recover -f /path/to/custom.backup.tdl
{{< /command >}}
12 changes: 6 additions & 6 deletions docs/content/zh/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ weight: 10
#### 安装最新版本

{{< command >}}
iwr -useb https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1 | iex
iwr -useb https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1 | iex
{{< /command >}}

#### 通过 `ghproxy.com` 镜像安装

{{< command >}}
$Script=iwr -useb https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Script=iwr -useb https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -ArgumentList "", "$True"
{{< /command >}}

#### 安装特定版本

{{< command >}}
$Env:TDLVersion = "VERSION"
$Script=iwr -useb https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Script=iwr -useb https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.ps1;
$Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -ArgumentList "$Env:TDLVersion"
{{< /command >}}

Expand All @@ -41,19 +41,19 @@ $Block=[ScriptBlock]::Create($Script); Invoke-Command -ScriptBlock $Block -Argum
#### 安装最新版本

{{< command >}}
curl -sSL https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash
curl -sSL https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash
{{< /command >}}

#### 通过 `ghproxy.com` 镜像安装

{{< command >}}
curl -sSL https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --proxy
curl -sSL https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --proxy
{{< /command >}}

#### 安装特定版本

{{< command >}}
curl -sSL https://ghproxy.com/https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --version VERSION
curl -sSL https://raw.githubusercontent.com/iyear/tdl/master/scripts/install.sh | sudo bash -s -- --version VERSION
{{< /command >}}

{{< /tab >}}
Expand Down
12 changes: 7 additions & 5 deletions docs/content/zh/guide/global-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@ tdl -n iyear

## `--proxy`

设置代理。目前仅支持 `socks5`默认值:`""`
设置代理。默认值:`""`

格式:`protocol://username:password@host:port`

{{< command >}}
tdl --proxy socks5://localhost:1080
tdl --proxy http://localhost:8080
tdl --proxy https://localhost:8081
{{< /command >}}

## `--ntp`
Expand All @@ -39,7 +41,7 @@ tdl --ntp pool.ntp.org
设置 Telegram 连接的重连超时。默认值:`2m`

{{< hint info >}}
如果您的网络不稳定,请将超时设置为较长时间或0(无限)。
如果您的网络不稳定,请将超时设置为更长时间或0(无限)。
{{< /hint >}}

{{< command >}}
Expand All @@ -56,10 +58,10 @@ tdl --debug

## `--pool`

设置 Telegram 客户端的连接池大小。默认值:`3`
设置 Telegram 客户端的连接池大小。默认值:`8`

{{< hint warning >}}
不要将其设置得过大,否则 Telegram 可能会强制断开连接
{{< hint info >}}
如果你想要更快的速度,请将连接池设置的更大或者0(无限)
{{< /hint >}}

{{< command >}}
Expand Down
8 changes: 4 additions & 4 deletions docs/content/zh/guide/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 50

## 备份

将您的数据备份到 zip 文件中。默认值:`tdl-backup-<time>.zip`
将您的数据备份到文件中。默认值:`<date>.backup.tdl`

{{< command >}}
tdl backup
Expand All @@ -18,13 +18,13 @@ tdl backup
或者指定输出文件:

{{< command >}}
tdl backup -d /path/to/backup.zip
tdl backup -d /path/to/custom.tdl
{{< /command >}}

## 恢复

从 zip 文件中恢复您的数据
从备份文件中恢复您的数据

{{< command >}}
tdl recover -f /path/to/backup.zip
tdl recover -f /path/to/custom.backup.tdl
{{< /command >}}

0 comments on commit 969d44a

Please sign in to comment.