Documentation syntax

This commit is contained in:
Matthias 2020-12-22 07:36:53 +01:00
parent 78dff3d510
commit 4dadfd199d

View File

@ -88,17 +88,22 @@ Example configuration showing the different settings:
``` ```
## Create a custom keyboard (command shortcut buttons) ## Create a custom keyboard (command shortcut buttons)
Telegram allows us to create a custom keyboard with buttons for commands. Telegram allows us to create a custom keyboard with buttons for commands.
The default custom keyboard looks like this. The default custom keyboard looks like this.
```python ```python
[ [
['/daily', '/profit', '/balance'], # row 1, 3 commands ["/daily", "/profit", "/balance"], # row 1, 3 commands
['/status', '/status table', '/performance'], # row 2, 3 commands ["/status", "/status table", "/performance"], # row 2, 3 commands
['/count', '/start', '/stop', '/help'] # row 3, 4 commands ["/count", "/start", "/stop", "/help"] # row 3, 4 commands
] ]
``` ```
### Usage ### Usage
You can create your own keyboard in `config.json`: You can create your own keyboard in `config.json`:
``` json ``` json
"telegram": { "telegram": {
"enabled": true, "enabled": true,
@ -107,14 +112,15 @@ You can create your own keyboard in `config.json`:
"keyboard": [ "keyboard": [
["/daily", "/stats", "/balance", "/profit"], ["/daily", "/stats", "/balance", "/profit"],
["/status table", "/performance"], ["/status table", "/performance"],
["/reload_config", "/count", "/logs"] ["/reload_config", "/count", "/logs"]
] ]
}, },
``` ```
!!! Note
Only a certain list of commands are allowed. Command arguments are not supported! !!! Note "Supported Commands"
### Supported Commands Only the following commands are allowed. Command arguments are not supported!
`/start`, `/stop`, `/status`, `/status table`, `/trades`, `/profit`, `/performance`, `/daily`, `/stats`, `/count`, `/locks`, `/balance`, `/stopbuy`, `/reload_config`, `/show_config`, `/logs`, `/whitelist`, `/blacklist`, `/edge`, `/help`, `/version`
`/start`, `/stop`, `/status`, `/status table`, `/trades`, `/profit`, `/performance`, `/daily`, `/stats`, `/count`, `/locks`, `/balance`, `/stopbuy`, `/reload_config`, `/show_config`, `/logs`, `/whitelist`, `/blacklist`, `/edge`, `/help`, `/version`
## Telegram commands ## Telegram commands