mirror of
https://github.com/glanceapp/glance.git
synced 2025-06-22 10:51:24 +02:00
Document lobsters widget
This commit is contained in:
parent
720549ec7e
commit
038c43bc09
@ -10,6 +10,7 @@
|
|||||||
- [RSS](#rss)
|
- [RSS](#rss)
|
||||||
- [Videos](#videos)
|
- [Videos](#videos)
|
||||||
- [Hacker News](#hacker-news)
|
- [Hacker News](#hacker-news)
|
||||||
|
- [Lobsters](#lobsters)
|
||||||
- [Reddit](#reddit)
|
- [Reddit](#reddit)
|
||||||
- [Weather](#weather)
|
- [Weather](#weather)
|
||||||
- [Monitor](#monitor)
|
- [Monitor](#monitor)
|
||||||
@ -491,6 +492,49 @@ Placeholders:
|
|||||||
|
|
||||||
`{POST-ID}` - the ID of the post
|
`{POST-ID}` - the ID of the post
|
||||||
|
|
||||||
|
### Lobsters
|
||||||
|
Display a list of posts from [Lobsters](https://lobste.rs).
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- type: lobsters
|
||||||
|
sort-by: hot
|
||||||
|
tags:
|
||||||
|
- go
|
||||||
|
- security
|
||||||
|
- linux
|
||||||
|
limit: 15
|
||||||
|
collapse-after: 5
|
||||||
|
```
|
||||||
|
|
||||||
|
<!--
|
||||||
|
TODO: add preview
|
||||||
|
|
||||||
|
Preview:
|
||||||
|

|
||||||
|
-->
|
||||||
|
|
||||||
|
#### Properties
|
||||||
|
| Name | Type | Required | Default |
|
||||||
|
| ---- | ---- | -------- | ------- |
|
||||||
|
| limit | integer | no | 15 |
|
||||||
|
| collapse-after | integer | no | 5 |
|
||||||
|
| sort-by | string | no | hot |
|
||||||
|
| tags | array | no | |
|
||||||
|
|
||||||
|
##### `limit`
|
||||||
|
The maximum number of posts to show.
|
||||||
|
|
||||||
|
##### `collapse-after`
|
||||||
|
How many posts are visible before the "SHOW MORE" button appears. Set to `-1` to never collapse.
|
||||||
|
|
||||||
|
##### `sort-by`
|
||||||
|
The sort order in which posts are returned. Possible options are `hot` and `new`.
|
||||||
|
|
||||||
|
##### `tags`
|
||||||
|
Limit to posts containing one of the given tags. **You cannot specify a sort order when filtering by tags, it will default to `hot`.**
|
||||||
|
|
||||||
### Reddit
|
### Reddit
|
||||||
Display a list of posts from a specific subreddit.
|
Display a list of posts from a specific subreddit.
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user