mirror of
				https://github.com/appleboy/ssh-action.git
				synced 2025-10-31 09:23:50 +00:00 
			
		
		
		
	docs: add comprehensive tables of contents to all README files
- Add a detailed table of contents to all three README files in English, Simplified Chinese, and Traditional Chinese for easier navigation. Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
		
							parent
							
								
									4d84f0522a
								
							
						
					
					
						commit
						8f3cc07719
					
				
							
								
								
									
										31
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										31
									
								
								README.md
									
									
									
									
									
								
							| @ -2,6 +2,37 @@ | ||||
| 
 | ||||
| English | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md) | ||||
| 
 | ||||
| ## Table of Contents | ||||
| 
 | ||||
| - [🚀 SSH for GitHub Actions](#-ssh-for-github-actions) | ||||
|   - [Table of Contents](#table-of-contents) | ||||
|   - [📖 Introduction](#-introduction) | ||||
|   - [🧩 Core Concepts \& Input Parameters](#-core-concepts--input-parameters) | ||||
|   - [⚡ Quick Start](#-quick-start) | ||||
|   - [🔑 SSH Key Setup \& OpenSSH Compatibility](#-ssh-key-setup--openssh-compatibility) | ||||
|     - [Setting Up SSH Keys](#setting-up-ssh-keys) | ||||
|       - [Generate RSA key](#generate-rsa-key) | ||||
|       - [Generate ED25519 key](#generate-ed25519-key) | ||||
|     - [OpenSSH Compatibility](#openssh-compatibility) | ||||
|   - [🛠️ Usage Scenarios \& Advanced Examples](#️-usage-scenarios--advanced-examples) | ||||
|     - [Using password authentication](#using-password-authentication) | ||||
|     - [Using private key authentication](#using-private-key-authentication) | ||||
|     - [Multiple commands](#multiple-commands) | ||||
|     - [Run commands from a file](#run-commands-from-a-file) | ||||
|     - [Multiple hosts](#multiple-hosts) | ||||
|     - [Multiple hosts with different ports](#multiple-hosts-with-different-ports) | ||||
|     - [Synchronous execution on multiple hosts](#synchronous-execution-on-multiple-hosts) | ||||
|     - [Pass environment variables to shell script](#pass-environment-variables-to-shell-script) | ||||
|   - [🌐 Proxy \& Jump Host Usage](#-proxy--jump-host-usage) | ||||
|   - [🛡️ Security Best Practices](#️-security-best-practices) | ||||
|     - [Protecting Your Private Key](#protecting-your-private-key) | ||||
|     - [Host Fingerprint Verification](#host-fingerprint-verification) | ||||
|   - [🚨 Error Handling \& Troubleshooting](#-error-handling--troubleshooting) | ||||
|     - [Q\&A](#qa) | ||||
|       - [Command not found (npm or other command)](#command-not-found-npm-or-other-command) | ||||
|   - [🤝 Contributing](#-contributing) | ||||
|   - [📝 License](#-license) | ||||
| 
 | ||||
| --- | ||||
| 
 | ||||
| ## 📖 Introduction | ||||
|  | ||||
| @ -2,6 +2,37 @@ | ||||
| 
 | ||||
| [English](./README.md) | [繁體中文](./README.zh-tw.md) | 简体中文 | ||||
| 
 | ||||
| ## 目录 | ||||
| 
 | ||||
| - [🚀 用于 GitHub Actions 的 SSH](#-用于-github-actions-的-ssh) | ||||
|   - [目录](#目录) | ||||
|   - [📖 简介](#-简介) | ||||
|   - [🧩 核心概念与输入参数](#-核心概念与输入参数) | ||||
|   - [⚡ 快速开始](#-快速开始) | ||||
|   - [🔑 SSH 密钥配置与 OpenSSH 兼容性](#-ssh-密钥配置与-openssh-兼容性) | ||||
|     - [配置 SSH 密钥](#配置-ssh-密钥) | ||||
|       - [生成 RSA 密钥](#生成-rsa-密钥) | ||||
|       - [生成 ED25519 密钥](#生成-ed25519-密钥) | ||||
|     - [OpenSSH 兼容性](#openssh-兼容性) | ||||
|   - [🛠️ 用法场景与进阶示例](#️-用法场景与进阶示例) | ||||
|     - [使用密码认证](#使用密码认证) | ||||
|     - [使用私钥认证](#使用私钥认证) | ||||
|     - [多条命令](#多条命令) | ||||
|     - [从文件执行命令](#从文件执行命令) | ||||
|     - [多主机](#多主机) | ||||
|     - [多主机不同端口](#多主机不同端口) | ||||
|     - [多主机同步执行](#多主机同步执行) | ||||
|     - [传递环境变量到 shell 脚本](#传递环境变量到-shell-脚本) | ||||
|   - [🌐 代理与跳板机用法](#-代理与跳板机用法) | ||||
|   - [🛡️ 安全最佳实践](#️-安全最佳实践) | ||||
|     - [保护你的私钥](#保护你的私钥) | ||||
|     - [主机指纹验证](#主机指纹验证) | ||||
|   - [🚨 错误处理与疑难解答](#-错误处理与疑难解答) | ||||
|     - [常见问题](#常见问题) | ||||
|       - [命令未找到(npm 或其他命令)](#命令未找到npm-或其他命令) | ||||
|   - [🤝 贡献](#-贡献) | ||||
|   - [📝 许可证](#-许可证) | ||||
| 
 | ||||
| --- | ||||
| 
 | ||||
| ## 📖 简介 | ||||
|  | ||||
| @ -2,6 +2,37 @@ | ||||
| 
 | ||||
| [English](./README.md) | 繁體中文 | [简体中文](./README.zh-cn.md) | ||||
| 
 | ||||
| ## 目錄 | ||||
| 
 | ||||
| - [🚀 GitHub Actions 的 SSH](#-github-actions-的-ssh) | ||||
|   - [目錄](#目錄) | ||||
|   - [📖 簡介](#-簡介) | ||||
|   - [🧩 核心概念與輸入參數](#-核心概念與輸入參數) | ||||
|   - [⚡ 快速開始](#-快速開始) | ||||
|   - [🔑 SSH 金鑰設定與 OpenSSH 相容性](#-ssh-金鑰設定與-openssh-相容性) | ||||
|     - [設定 SSH 金鑰](#設定-ssh-金鑰) | ||||
|       - [產生 RSA 金鑰](#產生-rsa-金鑰) | ||||
|       - [產生 ED25519 金鑰](#產生-ed25519-金鑰) | ||||
|     - [OpenSSH 相容性](#openssh-相容性) | ||||
|   - [🛠️ 用法場景與進階範例](#️-用法場景與進階範例) | ||||
|     - [使用密碼認證](#使用密碼認證) | ||||
|     - [使用私鑰認證](#使用私鑰認證) | ||||
|     - [多條指令](#多條指令) | ||||
|     - [從檔案執行指令](#從檔案執行指令) | ||||
|     - [多主機](#多主機) | ||||
|     - [多主機不同埠號](#多主機不同埠號) | ||||
|     - [多主機同步執行](#多主機同步執行) | ||||
|     - [傳遞環境變數到 shell 腳本](#傳遞環境變數到-shell-腳本) | ||||
|   - [🌐 代理與跳板機用法](#-代理與跳板機用法) | ||||
|   - [🛡️ 安全最佳實踐](#️-安全最佳實踐) | ||||
|     - [保護你的私鑰](#保護你的私鑰) | ||||
|     - [主機指紋驗證](#主機指紋驗證) | ||||
|   - [🚨 錯誤處理與疑難排解](#-錯誤處理與疑難排解) | ||||
|     - [常見問題](#常見問題) | ||||
|       - [指令找不到(npm 或其他指令)](#指令找不到npm-或其他指令) | ||||
|   - [🤝 貢獻](#-貢獻) | ||||
|   - [📝 授權](#-授權) | ||||
| 
 | ||||
| --- | ||||
| 
 | ||||
| ## 📖 簡介 | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user