Skip to content

armgit / dashy

Public Imported from GitHub
0

🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

✨ 📝 document HN trending Widget

Josua Blejeru503d66206519
diff --git a/docs/widgets.md b/docs/widgets.md
index cc9a1450..bc722308 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -35,6 +35,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [GitHub Trending](#github-trending)
- [GitHub Profile Stats](#github-profile-stats)
- [Healthchecks Status](#healthchecks-status)
+ - [Hackernews Trending](#hackernews-trending)
- [Mvg Departure](#mvg-departure)
- [Mvg Connection](#mvg-connection)
- **[Self-Hosted Services Widgets](#self-hosted-services-widgets)**
@@ -1178,6 +1179,25 @@ Display status of one or more HealthChecks project(s). Works with healthcheck.io
---
+### Hackernews Trending
+
+Display new and trending Posts from Hackernews
+
+#### Options
+**Field** | **Type** | **Required** | **Description**
+--- | --- | --- | ---
+**`stories`** | `string` | _Optional_ | HN Stories to display defaults to `topstories`. Options are: `beststories`, `topstories` or `newstories`
+
+##### Example
+
+```yaml
+- type: hackernews-trending
+ options:
+ stories: newstories
+```
+
+---
+
### MVG Departure
Display departure time of a MVG (Münchner Verkehrs Gesellschaft) station.