Skip to content

Commit c7fbbc9

Browse files
committed
docs: add table of contents to multilingual README files
- Add a table of contents section to the English, Simplified Chinese, and Traditional Chinese readme files Signed-off-by: appleboy <[email protected]>
1 parent b80f638 commit c7fbbc9

File tree

3 files changed

+81
-0
lines changed

3 files changed

+81
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
English | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
44

5+
## Table of Contents
6+
7+
- [🚀 SSH for GitHub Actions](#-ssh-for-github-actions)
8+
- [Table of Contents](#table-of-contents)
9+
- [📥 Input Parameters](#-input-parameters)
10+
- [🚦 Usage Example](#-usage-example)
11+
- [🔑 Setting Up SSH Keys](#-setting-up-ssh-keys)
12+
- [Generate RSA key](#generate-rsa-key)
13+
- [Generate ED25519 key](#generate-ed25519-key)
14+
- [🛡️ OpenSSH Compatibility](#️-openssh-compatibility)
15+
- [🧑‍💻 More Usage Examples](#-more-usage-examples)
16+
- [Using password authentication](#using-password-authentication)
17+
- [Using private key authentication](#using-private-key-authentication)
18+
- [Multiple commands](#multiple-commands)
19+
- [Run commands from a file](#run-commands-from-a-file)
20+
- [Multiple hosts](#multiple-hosts)
21+
- [Multiple hosts with different ports](#multiple-hosts-with-different-ports)
22+
- [Synchronous execution on multiple hosts](#synchronous-execution-on-multiple-hosts)
23+
- [Pass environment variables to shell script](#pass-environment-variables-to-shell-script)
24+
- [🌐 Using ProxyCommand (Jump Host)](#-using-proxycommand-jump-host)
25+
- [🔒 Protecting Your Private Key](#-protecting-your-private-key)
26+
- [🖐️ Host Fingerprint Verification](#️-host-fingerprint-verification)
27+
- [❓ Q\&A](#-qa)
28+
- [Command not found (npm or other command)](#command-not-found-npm-or-other-command)
29+
- [🤝 Contributing](#-contributing)
30+
- [📝 License](#-license)
31+
532
A [GitHub Action](https://github.com/features/actions) for executing remote SSH commands easily and securely.
633

734
![ssh workflow](./images/ssh-workflow.png)

README.zh-cn.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
[English](./README.md) | [繁體中文](./README.zh-tw.md) | 简体中文
44

5+
## 目录
6+
7+
- [🚀 用于 GitHub Actions 的 SSH](#-用于-github-actions-的-ssh)
8+
- [目录](#目录)
9+
- [📥 输入参数](#-输入参数)
10+
- [🚦 使用示例](#-使用示例)
11+
- [🔑 配置 SSH 密钥](#-配置-ssh-密钥)
12+
- [生成 RSA 密钥](#生成-rsa-密钥)
13+
- [生成 ED25519 密钥](#生成-ed25519-密钥)
14+
- [🛡️ OpenSSH 兼容性](#️-openssh-兼容性)
15+
- [🧑‍💻 更多用法示例](#-更多用法示例)
16+
- [使用密码认证](#使用密码认证)
17+
- [使用私钥认证](#使用私钥认证)
18+
- [多条命令](#多条命令)
19+
- [从文件执行命令](#从文件执行命令)
20+
- [多主机](#多主机)
21+
- [多主机不同端口](#多主机不同端口)
22+
- [多主机同步执行](#多主机同步执行)
23+
- [传递环境变量到 shell 脚本](#传递环境变量到-shell-脚本)
24+
- [🌐 使用 ProxyCommand(跳板机)](#-使用-proxycommand跳板机)
25+
- [🔒 保护你的私钥](#-保护你的私钥)
26+
- [🖐️ 主机指纹验证](#️-主机指纹验证)
27+
- [❓ 常见问题](#-常见问题)
28+
- [命令未找到(npm 或其他命令)](#命令未找到npm-或其他命令)
29+
- [🤝 贡献](#-贡献)
30+
- [📝 许可证](#-许可证)
31+
532
一个让你轻松安全地执行远程 SSH 命令的 [GitHub Action](https://github.com/features/actions)
633

734
![ssh workflow](./images/ssh-workflow.png)

README.zh-tw.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,33 @@
22

33
[English](./README.md) | 繁體中文 | [简体中文](./README.zh-cn.md)
44

5+
## 目錄
6+
7+
- [🚀 GitHub Actions 的 SSH](#-github-actions-的-ssh)
8+
- [目錄](#目錄)
9+
- [📥 輸入參數](#-輸入參數)
10+
- [🚦 使用範例](#-使用範例)
11+
- [🔑 設定 SSH 金鑰](#-設定-ssh-金鑰)
12+
- [產生 RSA 金鑰](#產生-rsa-金鑰)
13+
- [產生 ED25519 金鑰](#產生-ed25519-金鑰)
14+
- [🛡️ OpenSSH 相容性](#️-openssh-相容性)
15+
- [🧑‍💻 更多用法範例](#-更多用法範例)
16+
- [使用密碼認證](#使用密碼認證)
17+
- [使用私鑰認證](#使用私鑰認證)
18+
- [多條指令](#多條指令)
19+
- [從檔案執行指令](#從檔案執行指令)
20+
- [多主機](#多主機)
21+
- [多主機不同埠號](#多主機不同埠號)
22+
- [多主機同步執行](#多主機同步執行)
23+
- [傳遞環境變數到 shell 腳本](#傳遞環境變數到-shell-腳本)
24+
- [🌐 使用 ProxyCommand(跳板機)](#-使用-proxycommand跳板機)
25+
- [🔒 保護你的私鑰](#-保護你的私鑰)
26+
- [🖐️ 主機指紋驗證](#️-主機指紋驗證)
27+
- [❓ 常見問題](#-常見問題)
28+
- [指令找不到(npm 或其他指令)](#指令找不到npm-或其他指令)
29+
- [🤝 貢獻](#-貢獻)
30+
- [📝 授權](#-授權)
31+
532
一個讓你輕鬆安全執行遠端 SSH 指令的 [GitHub Action](https://github.com/features/actions)
633

734
![ssh workflow](./images/ssh-workflow.png)

0 commit comments

Comments
 (0)