mirror of
https://github.com/appleboy/ssh-action.git
synced 2025-06-20 16:42:10 +10: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
3 changed files with 93 additions and 0 deletions
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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue