feat(docs): migrate documentation site into monorepo (#5912)

This commit is contained in:
Thomas authored and GitHub committed 2026-06-11 18:48:39 +02:00
1 parent 3e464a76f2
commit 9e421c67bd
605 files changed
+26764 -219

No files matched your search

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

@@ -0,0 +1,71 @@
---
title: 'Download Client'
description: 'Allows you to view and manage your Downloads from both Torrent and Usenet clients.'
hide_title: true
---
import { delugeIntegration } from '@site/docs/integrations/deluge';
import { nzbgetIntegration } from '@site/docs/integrations/nzbget';
import { qBittorentIntegration } from '@site/docs/integrations/q-bittorent';
import { sabnzbdIntegration } from '@site/docs/integrations/sabnzbd';
import { transmissionIntegration } from '@site/docs/integrations/transmission';
import { slskdIntegration } from '@site/docs/integrations/slskd';
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 { IconAd } from "@tabler/icons-react";
import TabItem from '@theme/TabItem';
import Tabs from '@theme/Tabs';
import { downloadsWidget } from '.';
<WidgetHeader
widget={downloadsWidget}
categories={['Torrent client', 'Usenet client', 'Downloads']}
/>
This widget displays a list of torrents or usenet-articles that are currently being downloaded, along with their progress and other relevant information.
### Screenshots
import downloadsCard from './img/screenshot.png';
<div>
<img src={downloadsCard} alt="downloads" width={128 * 4} />
</div>
### Supported Integrations
<WidgetIntegrations items={[{
integration: sabnzbdIntegration,
note: "Usenet client"
}, {
integration: nzbgetIntegration,
note: "Usenet client"
}, {
integration: delugeIntegration,
note: "Torrent client"
}, {
integration: transmissionIntegration,
note: "Torrent client"
}, {
integration: qBittorentIntegration,
note: "Torrent client"
}, {
integration: slskdIntegration,
note: "Soulseek client"
}]} />
### Interactions
- Pause / Resume one download by clicking on the according icon.
- Delete one download by clicking on the trash icon. (Can also delete the files)
- Pause / Resume all downloads by using the bottom button.
### Adding the widget
<AddingWidget />
### Configuration
<WidgetConfig configuration={downloadsWidget.configuration} />
+109
View File
@@ -0,0 +1,109 @@
import { WidgetDefinition } from "@site/src/types";
import { IconDownload } from "@tabler/icons-react";
const columnsList = [
"id",
"actions",
"added",
"category",
"downSpeed",
"index",
"integration",
"name",
"progress",
"ratio",
"received",
"sent",
"size",
"state",
"time",
"type",
"upSpeed",
];
const sortingExclusion = ["actions", "id", "state"];
const columnsSort = columnsList.filter((column) => !sortingExclusion.some((exclusion) => exclusion === column));
export const downloadsWidget: WidgetDefinition = {
icon: IconDownload,
name: "Download Client",
description: "Allows you to view and manage your Downloads from both Torrent and Usenet clients.",
path: "../../widgets/downloads",
configuration: {
items: [
{
name: "Columns to show",
description: "Select the columns you want to display in the widget.",
values: `List of columns: ${columnsList.join(", ")}`,
defaultValue: ["integration", "name", "progress", "time", "actions"].join(", "),
},
{
name: "Enable items sorting",
description: "Enables the sorting in the table.",
values: { type: "boolean" },
defaultValue: "no",
},
{
name: "Column used for sorting by default",
description: "By default it will sort by this column.",
defaultValue: "type",
values: `List of columns: ${columnsSort.join(", ")}`,
},
{
name: "Invert sorting",
description: "This will invert the sorting order of the table.",
values: { type: "boolean" },
defaultValue: "no",
},
{
name: "Show usenet entries marked as completed",
description: "This will show entries that have been completed in your Usenet client.",
values: { type: "boolean" },
defaultValue: "yes",
},
{
name: "Show torrent entries marked as completed",
description: "This will show entries that have been completed in your Torrent client.",
values: { type: "boolean" },
defaultValue: "yes",
},
{
name: "Show Miscellaneous entries marked as completed",
description: "This will show entries that have been completed in your Miscellaneous client.",
values: { type: "boolean" },
defaultValue: "yes",
},
{
name: "Hide completed torrent under this threshold (in kiB/s)",
description:
"This will hide completed torrent entries that have a download speed below the specified threshold.",
values: "Any number above 1, 0 to disable",
defaultValue: "0",
},
{
name: "Categories/names to filter",
description: "You can filter the items by categories or names. Use a comma to separate multiple values.",
values: "Comma-separated list of categories or names",
defaultValue: "-",
},
{
name: "Filter as a whitelist",
description:
"If enabled, only items that match the filter will be shown. If disabled, items that do not match the filter will be hidden.",
values: { type: "boolean" },
defaultValue: "no",
},
{
name: "Use filter to calculate Ratio",
description: "This will use the filter to calculate the ratio of items shown in the widget.",
values: { type: "boolean" },
defaultValue: "yes",
},
{
name: "Limit items per integration",
description: "This will limit the number of items shown per integration, not globally",
values: "Any number above 1",
defaultValue: "50",
},
],
},
};