Skip to content

Commit 42798ed

Browse files
committed
doc(plugins/rss): update
1 parent cb1c8d2 commit 42798ed

File tree

2 files changed

+27
-13
lines changed

2 files changed

+27
-13
lines changed

source/plugins/rss/README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
1-
### 🗼 Rss feed
2-
3-
The *rss* plugin displays items from a specified RSS feed.
4-
1+
<!--header-->
52
<table>
6-
<td align="center">
7-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.rss.svg">
8-
<img width="900" height="1" alt="">
9-
</td>
3+
<tr><th colspan="2"><h3>🗼 Rss feed</h3></th></tr>
4+
<tr><td colspan="2" align="center"><p>This plugin displays news from a given RSS feed.</p>
5+
</td></tr>
6+
<tr>
7+
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
8+
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/markdown"><code>📒 Markdown template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a></td>
9+
</tr>
10+
<tr>
11+
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
12+
</tr>
13+
<tr>
14+
<td><i>No tokens are required for this plugin</i></td>
15+
</tr>
16+
<tr>
17+
<td colspan="2" align="center">
18+
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.rss.svg" alt=""></img>
19+
<img width="900" height="1" alt="">
20+
</td>
21+
</tr>
1022
</table>
23+
<!--/header-->
1124

12-
#### ➡️ Available options
25+
## ➡️ Available options
1326

1427
<!--options-->
1528
<table>
@@ -51,9 +64,7 @@ The *rss* plugin displays items from a specified RSS feed.
5164
</table>
5265
<!--/options-->
5366

54-
*[→ Full specification](metadata.yml)*
55-
56-
#### ℹ️ Examples workflows
67+
## ℹ️ Examples workflows
5768

5869
<!--examples-->
5970
```yaml
@@ -68,4 +79,4 @@ with:
6879
plugin_rss_limit: 4
6980

7081
```
71-
<!--/examples-->
82+
<!--/examples-->

source/plugins/rss/metadata.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: "🗼 Rss feed"
22
category: social
3+
description: This plugin displays news from a given RSS feed.
4+
examples:
5+
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.rss.svg
36
index: 6.5
47
supports:
58
- user

0 commit comments

Comments
 (0)