doc(plugins/stargazers): update

This commit is contained in:
lowlighter
2022-01-15 19:43:43 -05:00
parent a5fd68994d
commit 043c05cab4
2 changed files with 28 additions and 16 deletions

View File

@@ -1,15 +1,27 @@
### ✨ Stargazers over last weeks <!--header-->
The *stargazers* plugin displays your stargazers evolution across all of your repositories over the last two weeks.
<table> <table>
<td align="center"> <tr><th colspan="2"><h3>✨ Stargazers over last weeks</h3></th></tr>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg"> <tr><td colspan="2" align="center"><p>This plugin displays your stargazers evolution across all of your repositories over the last two weeks.</p>
<img width="900" height="1" alt=""> </td></tr>
</td> <tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
</tr>
<tr>
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>repo (optional)</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<img width="900" height="1" alt="">
</td>
</tr>
</table> </table>
<!--/header-->
#### ➡️ Available options ## ➡️ Available options
<!--options--> <!--options-->
<table> <table>
@@ -18,7 +30,7 @@ The *stargazers* plugin displays your stargazers evolution across all of your re
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_stargazers</code></td> <td nowrap="nowrap"><code>plugin_stargazers</code></td>
<td rowspan="2"><p>Display stargazers metrics</p> <td rowspan="2"><p>Enable stargazers plugin</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>
@@ -29,9 +41,7 @@ The *stargazers* plugin displays your stargazers evolution across all of your re
</table> </table>
<!--/options--> <!--/options-->
*[→ Full specification](metadata.yml)* ## Examples workflows
#### Examples workflows
<!--examples--> <!--examples-->
```yaml ```yaml

View File

@@ -1,5 +1,8 @@
name: "✨ Stargazers over last weeks" name: "✨ Stargazers over last weeks"
category: github category: github
description: This plugin displays your stargazers evolution across all of your repositories over the last two weeks.
example:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg
index: 10 index: 10
supports: supports:
- user - user
@@ -9,8 +12,7 @@ scopes:
- public_access - public_access
inputs: inputs:
# Enable or disable plugin
plugin_stargazers: plugin_stargazers:
description: Display stargazers metrics description: Enable stargazers plugin
type: boolean type: boolean
default: no default: no