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 <appleboy.tw@gmail.com>
This commit is contained in:
appleboy 2025-04-27 09:53:26 +08:00
parent b80f638dc4
commit c7fbbc9208
No known key found for this signature in database
3 changed files with 81 additions and 0 deletions

View file

@ -2,6 +2,33 @@
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)
- [📥 Input Parameters](#-input-parameters)
- [🚦 Usage Example](#-usage-example)
- [🔑 Setting Up SSH Keys](#-setting-up-ssh-keys)
- [Generate RSA key](#generate-rsa-key)
- [Generate ED25519 key](#generate-ed25519-key)
- [🛡️ OpenSSH Compatibility](#-openssh-compatibility)
- [🧑‍💻 More Usage Examples](#-more-usage-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)
- [🌐 Using ProxyCommand (Jump Host)](#-using-proxycommand-jump-host)
- [🔒 Protecting Your Private Key](#-protecting-your-private-key)
- [🖐️ Host Fingerprint Verification](#-host-fingerprint-verification)
- [❓ Q\&A](#-qa)
- [Command not found (npm or other command)](#command-not-found-npm-or-other-command)
- [🤝 Contributing](#-contributing)
- [📝 License](#-license)
A [GitHub Action](https://github.com/features/actions) for executing remote SSH commands easily and securely.
![ssh workflow](./images/ssh-workflow.png)