refactor widget-only integrations
This commit is contained in:
122 files changed
+2259
-3016
No files matched your search
@@ -9,9 +9,8 @@ export const immichAlbumCarouselWidget: WidgetDefinition = {
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Album ID",
|
||||
description:
|
||||
"This is a unique ID which refers to your Immich album. You can find this id by opening an album and copying the unique string from the URL, for example 'a21aca09-9f05-47dc-b1a1-7b53c547226e'",
|
||||
name: "Album",
|
||||
description: "Select the Immich album to show in the slideshow.",
|
||||
values: { type: "string" },
|
||||
defaultValue: "",
|
||||
},
|
||||
@@ -27,6 +26,12 @@ export const immichAlbumCarouselWidget: WidgetDefinition = {
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "yes",
|
||||
},
|
||||
{
|
||||
name: "Randomize photos",
|
||||
description: "Show photos in a random order instead of always starting with the same album order.",
|
||||
values: { type: "boolean" },
|
||||
defaultValue: "no",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
@@ -1,69 +1,44 @@
|
||||
---
|
||||
title: 'Releases'
|
||||
description: 'Displays a list of the current version of the given repositories with the given version regex.'
|
||||
title: "Releases"
|
||||
description: "Displays a list of the current version of the given repositories with the given version regex."
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
|
||||
import { releasesWidget } from '.';
|
||||
import { githubIntegration } from '@site/docs/integrations/github';
|
||||
import { gitlabIntegration } from '@site/docs/integrations/gitlab';
|
||||
import { dockerHubIntegration } from '@site/docs/integrations/docker-hub';
|
||||
import { npmIntegration } from '@site/docs/integrations/npm';
|
||||
import { codebergIntegration } from '@site/docs/integrations/codeberg';
|
||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||
import { WidgetHeader } from "@site/src/components/widgets/header";
|
||||
import { releasesWidget } from ".";
|
||||
|
||||
<WidgetHeader
|
||||
widget={releasesWidget}
|
||||
categories={['Releases', 'Software']}
|
||||
/>
|
||||
<WidgetHeader widget={releasesWidget} categories={["Releases", "Software"]} />
|
||||
|
||||
The releases widget enables you to track a list of repositories and see their respective latest release.
|
||||
It also supports importing releases from your local docker containers.
|
||||
The releases widget enables you to track a list of repositories and see their respective latest release.
|
||||
It also supports importing releases from your local docker containers.
|
||||
|
||||
### Screenshots
|
||||
|
||||
import collapsibleCard from './img/collapsible.png';
|
||||
import fullCard from './img/full.png';
|
||||
import noDetailsCard from './img/no-details.png';
|
||||
import { quayIntegration } from '@site/docs/integrations/quay';
|
||||
import { gitHubContainerRegistryIntegration } from '@site/docs/integrations/github-containerregistry';
|
||||
import { linuxServerIoIntegration } from '@site/docs/integrations/linux-server-io';
|
||||
import collapsibleCard from "./img/collapsible.png";
|
||||
import fullCard from "./img/full.png";
|
||||
import noDetailsCard from "./img/no-details.png";
|
||||
|
||||
<div className='flex gap-1'>
|
||||
<div className="flex gap-1">
|
||||
<img src={fullCard} alt="releases full" width={128 * 3} />
|
||||
<img src={collapsibleCard} alt="releases collapsible" width={128 * 3} />
|
||||
<img src={noDetailsCard} alt="releases no details" width={128 * 3} />
|
||||
</div>
|
||||
|
||||
### Supported Integrations
|
||||
### Supported Providers
|
||||
|
||||
<WidgetIntegrations items={[{
|
||||
integration: githubIntegration,
|
||||
}, {
|
||||
integration: gitlabIntegration,
|
||||
}, {
|
||||
integration: dockerHubIntegration,
|
||||
}, {
|
||||
integration: npmIntegration,
|
||||
}, {
|
||||
integration: codebergIntegration,
|
||||
}, {
|
||||
integration: gitHubContainerRegistryIntegration,
|
||||
note: "Use if release is only available in ghcr.io"
|
||||
}, {
|
||||
integration: quayIntegration
|
||||
}, {
|
||||
integration: linuxServerIoIntegration
|
||||
}]} />
|
||||
GitHub, Docker Hub, GitLab, NPM, Codeberg, GitHub Container Registry, Quay, and LinuxServer.io are configured per repository in the widget.
|
||||
|
||||
For GitHub Container Registry, use `owner/package` identifiers such as `homarr-labs/homarr`.
|
||||
Full image references such as `ghcr.io/homarr-labs/homarr:latest` are also accepted.
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Configuration
|
||||
|
||||
<WidgetConfig configuration={releasesWidget.configuration} />
|
||||
|
||||
:::note
|
||||
@@ -74,4 +49,3 @@ Setting the Prefix to `v`, precision to `2` and the Suffix to `-alpha`, will mat
|
||||
Setting the Prefix to `v`, precision to `3`, will match `v5.2.0` but not `v1.0.2-alpha` or `Beta v5.2.1`.
|
||||
|
||||
:::
|
||||
|
||||
@@ -54,16 +54,22 @@ export const releasesWidget: WidgetDefinition = {
|
||||
items: [
|
||||
{
|
||||
name: "Provider",
|
||||
description: "Integration to fetch the repository from.",
|
||||
values: "Select from the available integrations.",
|
||||
description: "Provider to fetch the repository or package releases from.",
|
||||
values: "Select from the available providers.",
|
||||
defaultValue: "-",
|
||||
},
|
||||
{
|
||||
name: "Identifier",
|
||||
description: 'The identifier of the repository, e.g. "homarr-labs/homarr".',
|
||||
values: "Any valid repository identifier.",
|
||||
description: 'The identifier of the repository or package, e.g. "homarr-labs/homarr".',
|
||||
values: 'Any valid provider identifier. GHCR also accepts full image refs like "ghcr.io/owner/package:tag".',
|
||||
defaultValue: "-",
|
||||
},
|
||||
{
|
||||
name: "Provider URL",
|
||||
description: "Base URL for the provider.",
|
||||
values: "Any valid URL.",
|
||||
defaultValue: "Provider default",
|
||||
},
|
||||
{
|
||||
name: "Name",
|
||||
description: "Display name of the repository.",
|
||||
|
||||
@@ -1,44 +1,40 @@
|
||||
---
|
||||
title: 'Timetable'
|
||||
description: 'Displays departure times for a station.'
|
||||
title: "Timetable"
|
||||
description: "Displays departure times for a station."
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
import { AddingWidget } from '@site/src/components/widgets/adding';
|
||||
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
||||
import { WidgetHeader } from '@site/src/components/widgets/header';
|
||||
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
|
||||
import { timetableWidget } from '.';
|
||||
import { searchChIntegration } from '@site/docs/integrations/search-ch';
|
||||
import { AddingWidget } from "@site/src/components/widgets/adding";
|
||||
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
||||
import { WidgetHeader } from "@site/src/components/widgets/header";
|
||||
import { timetableWidget } from ".";
|
||||
|
||||
|
||||
<WidgetHeader
|
||||
widget={timetableWidget}
|
||||
categories={['Timetable']}
|
||||
/>
|
||||
<WidgetHeader widget={timetableWidget} categories={["Timetable"]} />
|
||||
|
||||
The Timetable widget provides real-time departure times for a selected station.
|
||||
|
||||
### Screenshots
|
||||
|
||||
import trainDepartures from './img/train-departures.png';
|
||||
import streetDepartures from './img/street-departures.png';
|
||||
import trainDepartures from "./img/train-departures.png";
|
||||
import streetDepartures from "./img/street-departures.png";
|
||||
|
||||
<div className="flex gap-2">
|
||||
<img src={trainDepartures} alt="timetable-widget-train-departures" width={128 * 2} />
|
||||
<img src={streetDepartures} alt="timetable-widget-bus-and-tram-departures" width={128 * 2} />
|
||||
<img
|
||||
src={trainDepartures}
|
||||
alt="timetable-widget-train-departures"
|
||||
width={128 * 2}
|
||||
/>
|
||||
<img
|
||||
src={streetDepartures}
|
||||
alt="timetable-widget-bus-and-tram-departures"
|
||||
width={128 * 2}
|
||||
/>
|
||||
</div>
|
||||
|
||||
### Adding the widget
|
||||
|
||||
<AddingWidget />
|
||||
|
||||
### Supported Integrations
|
||||
|
||||
<WidgetIntegrations items={[{
|
||||
integration: searchChIntegration,
|
||||
note: 'Switzerland only'
|
||||
}]} />
|
||||
|
||||
### Configuration
|
||||
|
||||
<WidgetConfig configuration={timetableWidget.configuration} />
|
||||
@@ -8,6 +8,12 @@ export const timetableWidget: WidgetDefinition = {
|
||||
path: "../../widgets/timetable",
|
||||
configuration: {
|
||||
items: [
|
||||
{
|
||||
name: "Search.ch URL",
|
||||
description: "Base URL for the Search.ch timetable API.",
|
||||
values: "Any valid URL.",
|
||||
defaultValue: "https://search.ch",
|
||||
},
|
||||
{
|
||||
name: "Station",
|
||||
description: "Select the station",
|
||||
|
||||
Reference in new issue
Block a user