diff --git a/docs/configuration.md b/docs/configuration.md index 917bdb1..264efb6 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -19,6 +19,7 @@ - [Repository](#repository) - [Bookmarks](#bookmarks) - [Calendar](#calendar) + - [ChangeDetection.io](#changedetectionio) - [Clock](#clock) - [Markets](#markets) - [Twitch Channels](#twitch-channels) @@ -1109,6 +1110,53 @@ Whether to open the link in the same tab or a new one. Whether to hide the colored arrow on each link. +### ChangeDetection.io +Display a list watches from changedetection.io. + +Example + +```yaml +- type: change-detection + instance-url: https://changedetection.mydomain.com/ + token: ${CHANGE_DETECTION_TOKEN} +``` + +Preview: + +![](images/change-detection-widget-preview.png) + +#### Properties + +| Name | Type | Required | Default | +| ---- | ---- | -------- | ------- | +| instance-url | string | no | `https://www.changedetection.io` | +| token | string | no | | +| limit | integer | no | 10 | +| collapse-after | integer | no | 5 | +| watches | array of strings | no | | + +##### `instance-url` +The URL pointing to your instance of `changedetection.io`. + +##### `token` +The API access token which can be found in `SETTINGS > API`. Optionally, you can specify this using an environment variable with the syntax `${VARIABLE_NAME}`. + +##### `limit` +The maximum number of watches to show. + +##### `collapse-after` +How many watches are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse. + +##### `watches` +By default all of the configured watches will be shown. Optionally, you can specify a list of UUIDs for the specific watches you want to have listed: + +```yaml + - type: change-detection + watches: + - 1abca041-6d4f-4554-aa19-809147f538d3 + - 705ed3e4-ea86-4d25-a064-822a6425be2c +``` + ### Clock Display a clock showing the current time and date. Optionally, also display the the time in other timezones. diff --git a/docs/images/change-detection-widget-preview.png b/docs/images/change-detection-widget-preview.png new file mode 100644 index 0000000..74b7fe7 Binary files /dev/null and b/docs/images/change-detection-widget-preview.png differ