From 1dfeaffef3be71a84d448d6ce2a64e5069b15c85 Mon Sep 17 00:00:00 2001 From: appleboy Date: Sat, 26 Apr 2025 22:00:28 +0800 Subject: [PATCH] docs: add Table of Contents to all language README files - Add a Table of Contents section to the English, Simplified Chinese, and Traditional Chinese README files Signed-off-by: appleboy --- README.md | 11 +++++++++++ README.zh-cn.md | 11 +++++++++++ README.zh-tw.md | 11 +++++++++++ 3 files changed, 33 insertions(+) diff --git a/README.md b/README.md index c7d5803..4826a8a 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,17 @@ A Drone plugin for executing commands on remote hosts via SSH. For usage instruc ![demo](./images/demo2017.05.10.gif) +## Table of Contents + +- [drone-ssh](#drone-ssh) + - [Table of Contents](#table-of-contents) + - [Breaking Changes](#breaking-changes) + - [Build or Download a Binary](#build-or-download-a-binary) + - [Docker](#docker) + - [Usage](#usage) + - [Mount Key from File Path](#mount-key-from-file-path) + - [Configuration](#configuration) + ## Breaking Changes As of `v1.5.0`, the command timeout flag has changed to use the `Duration` format. See the following example: diff --git a/README.zh-cn.md b/README.zh-cn.md index 9a8066f..379db18 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -21,6 +21,17 @@ Drone 插件,可通过 SSH 在远程主机执行命令。使用方法和可用 +## 目录 + +- [drone-ssh](#drone-ssh) + - [目录](#目录) + - [重大变更](#重大变更) + - [构建或下载二进制文件](#构建或下载二进制文件) + - [Docker](#docker) + - [使用方法](#使用方法) + - [通过文件路径挂载密钥](#通过文件路径挂载密钥) + - [配置说明](#配置说明) + ## 重大变更 `v1.5.0`:将命令超时参数更改为 `Duration` 格式。设置示例如下: diff --git a/README.zh-tw.md b/README.zh-tw.md index 97e626c..49f6c08 100644 --- a/README.zh-tw.md +++ b/README.zh-tw.md @@ -21,6 +21,17 @@ Drone 外掛程式,可透過 SSH 在遠端主機執行指令。使用方式與 +## 目錄 + +- [drone-ssh](#drone-ssh) + - [目錄](#目錄) + - [重大變更](#重大變更) + - [建置或下載執行檔](#建置或下載執行檔) + - [Docker](#docker) + - [使用方式](#使用方式) + - [以檔案路徑掛載金鑰](#以檔案路徑掛載金鑰) + - [設定說明](#設定說明) + ## 重大變更 `v1.5.0`:將指令逾時參數改為 `Duration` 格式。設定範例如下: