0ct0pu5/glance
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation update

Browse source
This commit is contained in:
dvdandroid 2024-08-04 15:27:19 +02:00
parent c2f8fdb291
commit 7dc9c6b56a
1 changed files with 25 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/configuration.md
View file

@ -1043,14 +1043,19 @@ You can hover over the "ERROR" text to view more information.
#### Properties
| Name | Type | Required |
| ---- | ---- | -------- |
| sites | array | yes |
| style | string | no |
| Name | Type | Required | Default |
| ---- | ---- | -------- |---------|
| sites | array | yes | |
| collapse-after | integer | no | 5 |
| style | string | no | |
##### `style`
To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option.
##### `collapse-after`
How many sites are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse.
##### `sites`
Properties for each site:
@ -1128,6 +1133,7 @@ Preview:
| gitlab-token | string | no | |
| limit | integer | no | 10 |
| collapse-after | integer | no | 5 |
| style | string | no | |
##### `repositories`
A list of repositores to fetch the latest release for. Only the name/repo is required, not the full URL. A prefix can be specified for repositories hosted elsewhere such as GitLab and Docker Hub. Example:
@ -1191,6 +1197,9 @@ The maximum number of releases to show.
#### `collapse-after`
How many releases are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse.
##### `style`
To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option.
### Repository
Display general information about a repository as well as a list of the latest open pull requests and issues.
@ -1347,6 +1356,7 @@ Preview:
| limit | integer | no | 10 |
| collapse-after | integer | no | 5 |
| watches | array of strings | no | |
| style | string | no | |
##### `instance-url`
The URL pointing to your instance of `changedetection.io`.
@ -1370,6 +1380,9 @@ By default all of the configured watches will be shown. Optionally, you can spec
- 705ed3e4-ea86-4d25-a064-822a6425be2c
```
##### `style`
To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option.
### Clock
Display a clock showing the current time and date. Optionally, also display the the time in other timezones.
@ -1521,6 +1534,7 @@ Preview:
| channels | array | yes | |
| collapse-after | integer | no | 5 |
| sort-by | string | no | viewers |
| style | string | no | |
##### `channels`
A list of channels to display.
@ -1531,6 +1545,9 @@ How many channels are visible before the "SHOW MORE" button appears. Set to `-1`
##### `sort-by`
Can be used to specify the order in which the channels are displayed. Possible values are `viewers` and `live`.
##### `style`
To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option.
### Twitch top games
Display a list of games with the most viewers on Twitch.
@ -1556,6 +1573,7 @@ Preview:
| exclude | array | no | |
| limit | integer | no | 10 |
| collapse-after | integer | no | 5 |
| style | string | no | |
##### `exclude`
A list of categories that will never be shown. You must provide the slug found by clicking on the category and looking at the URL:
@ -1571,6 +1589,9 @@ The maximum number of games to show.
##### `collapse-after`
How many games are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse.
##### `style`
To make the widget scale appropriately in a `full` size column, set the style to the experimental `dynamic-columns-experimental` option.
### iframe
Embed an iframe as a widget.