doc(plugins/gists): update

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

View File

@@ -1,15 +1,27 @@
### 🎫 Gists <!--header-->
The *gists* plugin displays your [gists](https://gist.github.com) metrics.
<table> <table>
<td align="center"> <tr><th colspan="2"><h3>🎫 Gists</h3></th></tr>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.gists.svg"> <tr><td colspan="2" align="center"><p>This plugin displays <a href="https://gist.github.com">gists</a> stats.</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/terminal"><code>📙 Terminal template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</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 *gists* plugin displays your [gists](https://gist.github.com) metrics.
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_gists</code></td> <td nowrap="nowrap"><code>plugin_gists</code></td>
<td rowspan="2"><p>Display gists metrics</p> <td rowspan="2"><p>Enable gists 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 *gists* plugin displays your [gists](https://gist.github.com) metrics.
</table> </table>
<!--/options--> <!--/options-->
*[→ Full specification](metadata.yml)* ## Examples workflows
#### Examples workflows
<!--examples--> <!--examples-->
```yaml ```yaml

View File

@@ -1,5 +1,8 @@
name: "🎫 Gists" name: "🎫 Gists"
category: github category: github
description: This plugin displays [gists](https://gist.github.com) stats.
example:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.gists.svg
index: 21 index: 21
supports: supports:
- user - user
@@ -7,8 +10,7 @@ scopes:
- public_access - public_access
inputs: inputs:
# Enable or disable plugin
plugin_gists: plugin_gists:
description: Display gists metrics description: Enable gists plugin
type: boolean type: boolean
default: no default: no