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

2026-06-11 18:48:39 +02:00
1 parent 3e464a76f2
commit 9e421c67bd
@@ -0,0 +1,48 @@
+---
+title: 'RSS Feed'
+description: 'Monitor and display one or more generic RSS, ATOM or JSON feeds.'
+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 { rssFeedWidget } from '.';
+
+
+<WidgetHeader
+  widget={rssFeedWidget}
+  categories={['Feeds']}
+/>
+
+Using the RSS standard, you can integrate most News websites, applications and more on your dashboard.
+
+### Screenshots
+
+import screenshot from './img/screenshot.png';
+
+<img src={screenshot} alt="rss-feed noted-lol" width={128 * 4} />
+
+### Adding the widget
+
+<AddingWidget />
+
+### Configuration
+<WidgetConfig configuration={rssFeedWidget.configuration} />
+
+### Examples
+Here's a small collection of examples, that you can use for testing or actual use (in no particular order):
+- https://noted.lol/rss/
+- https://blog.google/products/chrome/rss/
+- https://www.w3.org/blog/feed/
+- https://partner-feeds.beta.20min.ch/rss/20minuten
+- http://rss.cnn.com/rss/money_topstories.rss
+- https://www.wired.com/rss/
+- http://www.chinadaily.com.cn/rss/world_rss.xml
+- https://www.srf.ch/news/bnf/rss/1646
+- https://torrentfreak.com/feed/
+- http://rss.nytimes.com/services/xml/rss/nyt/HomePage.xml
+- http://feeds.foxnews.com/foxnews/latest
+
+There is a good list of feeds here:
+https://github.com/greysonp/rss-feeds/blob/master/feeds.json
@@ -0,0 +1,65 @@
+import { WidgetDefinition } from "@site/src/types";
+import { IconRss } from "@tabler/icons-react";
+
+export const rssFeedWidget: WidgetDefinition = {
+  icon: IconRss,
+  name: "RSS Feed",
+  description: "Monitor and display one or more generic RSS, ATOM or JSON feeds.",
+  path: "../../widgets/rss-feed",
+  configuration: {
+    items: [
+      {
+        name: "Feed URLs",
+        description: (
+          <span>
+            A list of RSS feed URLs. They must conform to one of the following standards{" "}
+            <a href="https://www.rssboard.org/rss-specification" target="_blank" referrerPolicy="no-referrer">
+              RSS
+            </a>
+            ,{" "}
+            <a href="https://datatracker.ietf.org/doc/html/rfc5023" target="_blank" referrerPolicy="no-referrer">
+              ATOM
+            </a>{" "}
+            or{" "}
+            <a href="https://www.jsonfeed.org/version/1.1/" target="_blank" referrerPolicy="no-referrer">
+              JSON Feed
+            </a>
+            .
+          </span>
+        ),
+        defaultValue: "Empty list",
+        values: "List of URLs",
+      },
+      {
+        name: "Enable RTL",
+        description: "Enable right-to-left layout for feeds in such languages",
+        values: { type: "boolean" },
+        defaultValue: "no",
+      },
+      {
+        name: "Description line clamp",
+        description: "Maximum number of lines to show for the feed description",
+        values: "1-50",
+        defaultValue: "5",
+      },
+      {
+        name: "Amount posts limit",
+        description: "Maximum number of posts to show",
+        values: "1-9999",
+        defaultValue: "100",
+      },
+      {
+        name: "Hide description",
+        description: "Hide the description of individual feeds",
+        values: { type: "boolean" },
+        defaultValue: "no",
+      },
+      {
+        name: "Show poster image",
+        description: "Show the poster image beside the content",
+        values: { type: "boolean" },
+        defaultValue: "no",
+      },
+    ],
+  },
+};