Back to Metrics

README

source/plugins/rss/README.md

3.342.4 KB
Original Source
<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>šŸ—¼ Rss feed</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays news from a given RSS feed.</p> </td></tr> <tr> <th rowspan="3">Supported features <sub><a href="metadata.yml">→ Full specification</a></sub></th> <td><a href="/source/templates/classic/README.md"><code>šŸ“— Classic template</code></a> <a href="/source/templates/markdown/README.md"><code>šŸ“’ Markdown template</code></a> <a href="/source/templates/repository/README.md"><code>šŸ“˜ Repository template</code></a></td> </tr> <tr> <td><code>šŸ‘¤ Users</code> <code>šŸ‘„ Organizations</code> <code>šŸ““ Repositories</code></td> </tr> <tr> <td><i>No tokens are required for this plugin</i></td> </tr> <tr> <td colspan="2" align="center"> </img>
</td>
</tr> </table> <!--/header-->

āž”ļø Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_rss</code></h4></td> <td rowspan="2"><p>Enable rss plugin</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_rss_source</code></h4></td> <td rowspan="2"><p>RSS feed source</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code> </td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_rss_limit</code></h4></td> <td rowspan="2"><p>Display limit</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ š‘„ ≤ 30)</i>

<b>zero behaviour:</b> disable</br> <b>default:</b> 4

</td> </tr> </table> <!--/options-->

ā„¹ļø Examples workflows

<!--examples-->
yaml
name: News from hackernews
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.rss.svg
  token: NOT_NEEDED
  base: ""
  plugin_rss: yes
  plugin_rss_source: https://news.ycombinator.com/rss
  plugin_rss_limit: 4

<!--/examples-->