Skip to content

Commit b76e617

Browse files
committed
docs(readme): standardize and format README files across languages
- Remove an empty line in `README.md` - Replace underscores with bold formatting for default key types in `README.zh-cn.md` and `README.zh-tw.md` - Standardize list formatting in `README.md`, `README.zh-cn.md`, and `README.zh-tw.md` Signed-off-by: appleboy <appleboy.tw@gmail.com>
1 parent 6137f73 commit b76e617

File tree

3 files changed

+38
-41
lines changed

3 files changed

+38
-41
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,18 @@ Executing remote SSH commands.
6060
name: remote ssh command
6161
on: [push]
6262
jobs:
63-
6463
build:
6564
name: Build
6665
runs-on: ubuntu-latest
6766
steps:
68-
- name: executing remote ssh commands using password
69-
uses: appleboy/ssh-action@v1.2.0
70-
with:
71-
host: ${{ secrets.HOST }}
72-
username: linuxserver.io
73-
password: ${{ secrets.PASSWORD }}
74-
port: ${{ secrets.PORT }}
75-
script: whoami
67+
- name: executing remote ssh commands using password
68+
uses: appleboy/ssh-action@v1.2.0
69+
with:
70+
host: ${{ secrets.HOST }}
71+
username: linuxserver.io
72+
password: ${{ secrets.PASSWORD }}
73+
port: ${{ secrets.PORT }}
74+
script: whoami
7675
```
7776
7877
output:
@@ -152,9 +151,9 @@ See the detail information about [SSH login without password](http://www.linuxpr
152151

153152
**A note** from one of our readers: Depending on your version of SSH you might also have to do the following changes:
154153

155-
* Put the public key in `.ssh/authorized_keys2`
156-
* Change the permissions of `.ssh` to 700
157-
* Change the permissions of `.ssh/authorized_keys2` to 640
154+
- Put the public key in `.ssh/authorized_keys2`
155+
- Change the permissions of `.ssh` to 700
156+
- Change the permissions of `.ssh/authorized_keys2` to 640
158157

159158
### If you are using OpenSSH
160159

@@ -231,7 +230,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
231230
username: ${{ secrets.USERNAME }}
232231
key: ${{ secrets.KEY }}
233232
port: ${{ secrets.PORT }}
234-
script_path: scripts/script.sh
233+
script_path: scripts/script.sh
235234
```
236235
237236
#### Multiple Hosts

README.zh-cn.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,18 @@
5757
name: remote ssh command
5858
on: [push]
5959
jobs:
60-
6160
build:
6261
name: Build
6362
runs-on: ubuntu-latest
6463
steps:
65-
- name: executing remote ssh commands using password
66-
uses: appleboy/ssh-action@v1.2.0
67-
with:
68-
host: ${{ secrets.HOST }}
69-
username: ${{ secrets.USERNAME }}
70-
password: ${{ secrets.PASSWORD }}
71-
port: ${{ secrets.PORT }}
72-
script: whoami
64+
- name: executing remote ssh commands using password
65+
uses: appleboy/ssh-action@v1.2.0
66+
with:
67+
host: ${{ secrets.HOST }}
68+
username: ${{ secrets.USERNAME }}
69+
password: ${{ secrets.PASSWORD }}
70+
port: ${{ secrets.PORT }}
71+
script: whoami
7372
```
7473
7574
画面输出
@@ -132,9 +131,9 @@ clip < ~/.ssh/id_ed25519
132131

133132
**来自读者的注意事项**: 根据您的 SSH 版本,您可能还需要进行以下更改:
134133

135-
* 将公钥放在 `.ssh/authorized_keys2`
136-
*`.ssh` 的权限更改为700
137-
*`.ssh/authorized_keys2` 的权限更改为640
134+
- 将公钥放在 `.ssh/authorized_keys2`
135+
-`.ssh` 的权限更改为 700
136+
-`.ssh/authorized_keys2` 的权限更改为 640
138137

139138
### 如果你使用的是 OpenSSH
140139

@@ -227,7 +226,7 @@ ssh-keygen -t ed25519 -a 200 -C ”your_email@example.com“
227226
username: ${{ secrets.USERNAME }}
228227
key: ${{ secrets.KEY }}
229228
port: ${{ secrets.PORT }}
230-
script_path: scripts/script.sh
229+
script_path: scripts/script.sh
231230
```
232231
233232
#### 多个不同端口的主机
@@ -380,7 +379,7 @@ Host FooServer
380379

381380
设置 SSH 主机指纹验证可以帮助防止中间人攻击。在设置之前,运行以下命令以获取 SSH 主机指纹。请记得将 `ed25519` 替换为您适当的密钥类型(`rsa`、 `dsa`等),而 `example.com` 则替换为您的主机。
382381

383-
现代 OpenSSH 版本中,需要提取的_默认密钥_类型是 `rsa`(从版本 5.1 开始)、`ecdsa`(从版本 6.0 开始)和 `ed25519`(从版本 6.7 开始)。
382+
现代 OpenSSH 版本中,需要提取的**默认密钥**类型是 `rsa`(从版本 5.1 开始)、`ecdsa`(从版本 6.0 开始)和 `ed25519`(从版本 6.7 开始)。
384383

385384
```sh
386385
ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ’ ‘ -f2

README.zh-tw.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,18 @@
6060
name: remote ssh command
6161
on: [push]
6262
jobs:
63-
6463
build:
6564
name: Build
6665
runs-on: ubuntu-latest
6766
steps:
68-
- name: executing remote ssh commands using password
69-
uses: appleboy/ssh-action@v1.2.0
70-
with:
71-
host: ${{ secrets.HOST }}
72-
username: ${{ secrets.USERNAME }}
73-
password: ${{ secrets.PASSWORD }}
74-
port: ${{ secrets.PORT }}
75-
script: whoami
67+
- name: executing remote ssh commands using password
68+
uses: appleboy/ssh-action@v1.2.0
69+
with:
70+
host: ${{ secrets.HOST }}
71+
username: ${{ secrets.USERNAME }}
72+
password: ${{ secrets.PASSWORD }}
73+
port: ${{ secrets.PORT }}
74+
script: whoami
7675
```
7776
7877
畫面輸出
@@ -135,9 +134,9 @@ clip < ~/.ssh/id_ed25519
135134

136135
**來自讀者的注意事項**: 根據您的 SSH 版本,您可能還需要進行以下更改:
137136

138-
* 將公鑰放在 `.ssh/authorized_keys2`
139-
*`.ssh` 的權限更改為700
140-
*`.ssh/authorized_keys2` 的權限更改為640
137+
- 將公鑰放在 `.ssh/authorized_keys2`
138+
-`.ssh` 的權限更改為 700
139+
-`.ssh/authorized_keys2` 的權限更改為 640
141140

142141
### 如果你使用的是 OpenSSH
143142

@@ -214,7 +213,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
214213
username: ${{ secrets.USERNAME }}
215214
key: ${{ secrets.KEY }}
216215
port: ${{ secrets.PORT }}
217-
script_path: scripts/script.sh
216+
script_path: scripts/script.sh
218217
```
219218
220219
#### 多台主機
@@ -383,7 +382,7 @@ Host FooServer
383382

384383
設置 SSH 主機指紋驗證可以幫助防止中間人攻擊。在設置之前,運行以下命令以獲取 SSH 主機指紋。請記得將 `ed25519` 替換為您的適當金鑰類型(`rsa`、 `dsa`等),而 `example.com` 則替換為您的主機。
385384

386-
現代 OpenSSH 版本中,需要提取的_默認金鑰_類型是 `rsa`(從版本 5.1 開始)、`ecdsa`(從版本 6.0 開始)和 `ed25519`(從版本 6.7 開始)。
385+
現代 OpenSSH 版本中,需要提取的**默認金鑰**類型是 `rsa`(從版本 5.1 開始)、`ecdsa`(從版本 6.0 開始)和 `ed25519`(從版本 6.7 開始)。
387386

388387
```sh
389388
ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' ' -f2

0 commit comments

Comments
 (0)