appleboy/telegram-action
1
0
Fork 0
mirror of https://github.com/appleboy/telegram-action.git synced 2026-05-14 02:42:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve documentation formatting and API usage

Browse Source 
- Convert the list of optional parameters to a table format for better readability
- Fix the table formatting in the "See the result" section

Signed-off-by: appleboy <appleboy.tw@gmail.com>
This commit is contained in:
appleboy
2024-11-20 22:08:01 +08:00
parent 221e6b6849
commit 94584eda62
1 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -16
View File
@@ -49,21 +49,23 @@ Remove `args` to send the default message.
## Input variables
* socks5 - optional. support socks5 proxy URL
* photo - optional. photo message
* document - optional. document message
* sticker - optional. sticker message
* audio - optional. audio message
* voice - optional. voice message
* location - optional. location message
* venue - optional. venue message
* video - optional. video message
* debug - optional. enable debug mode
* format - optional. `markdown` or `html`. See [MarkdownV2 style](https://core.telegram.org/bots/api#markdownv2-style)
* message - optional. custom message
* message_file - optional. overwrite the default message template with the contents of the specified file.
* disable_web_page_preview - optional. disables link previews for links in this message. default is `false`.
* disable_notification - optional. disables notifications for this message, supports sending a message without notification. default is `false`.
| Variable | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| socks5 | optional. support socks5 proxy URL |
| photo | optional. photo message |
| document | optional. document message |
| sticker | optional. sticker message |
| audio | optional. audio message |
| voice | optional. voice message |
| location | optional. location message |
| venue | optional. venue message |
| video | optional. video message |
| debug | optional. enable debug mode |
| format | optional. `markdown` or `html`. See [MarkdownV2 style](https://core.telegram.org/bots/api#markdownv2-style) |
| message | optional. custom message |
| message_file | optional. overwrite the default message template with the contents of the specified file. |
| disable_web_page_preview | optional. disables link previews for links in this message. default is `false`. |
| disable_notification | optional. disables notifications for this message, supports sending a message without notification. default is `false`. |
## Example
@@ -154,7 +156,7 @@ See the result: (get chat id like `65382999`)
## Template variable
| Github Variable | Telegram Template Variable |
|-------------------|----------------------------|
| ----------------- | -------------------------- |
| GITHUB_REPOSITORY | repo |
| GITHUB_ACTOR | repo.namespace |
| GITHUB_SHA | commit.sha |