Skip to content

Commit 8f3cc07

Browse files
committed
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 <[email protected]>
1 parent 4d84f05 commit 8f3cc07

File tree

3 files changed

+93
-0
lines changed

3 files changed

+93
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,37 @@
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+
- [📖 Introduction](#-introduction)
10+
- [🧩 Core Concepts \& Input Parameters](#-core-concepts--input-parameters)
11+
- [⚡ Quick Start](#-quick-start)
12+
- [🔑 SSH Key Setup \& OpenSSH Compatibility](#-ssh-key-setup--openssh-compatibility)
13+
- [Setting Up SSH Keys](#setting-up-ssh-keys)
14+
- [Generate RSA key](#generate-rsa-key)
15+
- [Generate ED25519 key](#generate-ed25519-key)
16+
- [OpenSSH Compatibility](#openssh-compatibility)
17+
- [🛠️ Usage Scenarios \& Advanced Examples](#️-usage-scenarios--advanced-examples)
18+
- [Using password authentication](#using-password-authentication)
19+
- [Using private key authentication](#using-private-key-authentication)
20+
- [Multiple commands](#multiple-commands)
21+
- [Run commands from a file](#run-commands-from-a-file)
22+
- [Multiple hosts](#multiple-hosts)
23+
- [Multiple hosts with different ports](#multiple-hosts-with-different-ports)
24+
- [Synchronous execution on multiple hosts](#synchronous-execution-on-multiple-hosts)
25+
- [Pass environment variables to shell script](#pass-environment-variables-to-shell-script)
26+
- [🌐 Proxy \& Jump Host Usage](#-proxy--jump-host-usage)
27+
- [🛡️ Security Best Practices](#️-security-best-practices)
28+
- [Protecting Your Private Key](#protecting-your-private-key)
29+
- [Host Fingerprint Verification](#host-fingerprint-verification)
30+
- [🚨 Error Handling \& Troubleshooting](#-error-handling--troubleshooting)
31+
- [Q\&A](#qa)
32+
- [Command not found (npm or other command)](#command-not-found-npm-or-other-command)
33+
- [🤝 Contributing](#-contributing)
34+
- [📝 License](#-license)
35+
536
---
637

738
## 📖 Introduction

README.zh-cn.md

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

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

5+
## 目录
6+
7+
- [🚀 用于 GitHub Actions 的 SSH](#-用于-github-actions-的-ssh)
8+
- [目录](#目录)
9+
- [📖 简介](#-简介)
10+
- [🧩 核心概念与输入参数](#-核心概念与输入参数)
11+
- [⚡ 快速开始](#-快速开始)
12+
- [🔑 SSH 密钥配置与 OpenSSH 兼容性](#-ssh-密钥配置与-openssh-兼容性)
13+
- [配置 SSH 密钥](#配置-ssh-密钥)
14+
- [生成 RSA 密钥](#生成-rsa-密钥)
15+
- [生成 ED25519 密钥](#生成-ed25519-密钥)
16+
- [OpenSSH 兼容性](#openssh-兼容性)
17+
- [🛠️ 用法场景与进阶示例](#️-用法场景与进阶示例)
18+
- [使用密码认证](#使用密码认证)
19+
- [使用私钥认证](#使用私钥认证)
20+
- [多条命令](#多条命令)
21+
- [从文件执行命令](#从文件执行命令)
22+
- [多主机](#多主机)
23+
- [多主机不同端口](#多主机不同端口)
24+
- [多主机同步执行](#多主机同步执行)
25+
- [传递环境变量到 shell 脚本](#传递环境变量到-shell-脚本)
26+
- [🌐 代理与跳板机用法](#-代理与跳板机用法)
27+
- [🛡️ 安全最佳实践](#️-安全最佳实践)
28+
- [保护你的私钥](#保护你的私钥)
29+
- [主机指纹验证](#主机指纹验证)
30+
- [🚨 错误处理与疑难解答](#-错误处理与疑难解答)
31+
- [常见问题](#常见问题)
32+
- [命令未找到(npm 或其他命令)](#命令未找到npm-或其他命令)
33+
- [🤝 贡献](#-贡献)
34+
- [📝 许可证](#-许可证)
35+
536
---
637

738
## 📖 简介

README.zh-tw.md

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

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

5+
## 目錄
6+
7+
- [🚀 GitHub Actions 的 SSH](#-github-actions-的-ssh)
8+
- [目錄](#目錄)
9+
- [📖 簡介](#-簡介)
10+
- [🧩 核心概念與輸入參數](#-核心概念與輸入參數)
11+
- [⚡ 快速開始](#-快速開始)
12+
- [🔑 SSH 金鑰設定與 OpenSSH 相容性](#-ssh-金鑰設定與-openssh-相容性)
13+
- [設定 SSH 金鑰](#設定-ssh-金鑰)
14+
- [產生 RSA 金鑰](#產生-rsa-金鑰)
15+
- [產生 ED25519 金鑰](#產生-ed25519-金鑰)
16+
- [OpenSSH 相容性](#openssh-相容性)
17+
- [🛠️ 用法場景與進階範例](#️-用法場景與進階範例)
18+
- [使用密碼認證](#使用密碼認證)
19+
- [使用私鑰認證](#使用私鑰認證)
20+
- [多條指令](#多條指令)
21+
- [從檔案執行指令](#從檔案執行指令)
22+
- [多主機](#多主機)
23+
- [多主機不同埠號](#多主機不同埠號)
24+
- [多主機同步執行](#多主機同步執行)
25+
- [傳遞環境變數到 shell 腳本](#傳遞環境變數到-shell-腳本)
26+
- [🌐 代理與跳板機用法](#-代理與跳板機用法)
27+
- [🛡️ 安全最佳實踐](#️-安全最佳實踐)
28+
- [保護你的私鑰](#保護你的私鑰)
29+
- [主機指紋驗證](#主機指紋驗證)
30+
- [🚨 錯誤處理與疑難排解](#-錯誤處理與疑難排解)
31+
- [常見問題](#常見問題)
32+
- [指令找不到(npm 或其他指令)](#指令找不到npm-或其他指令)
33+
- [🤝 貢獻](#-貢獻)
34+
- [📝 授權](#-授權)
35+
536
---
637

738
## 📖 簡介

0 commit comments

Comments
 (0)