doc(plugins/sponsors): update

This commit is contained in:
lowlighter
2022-01-15 21:20:33 -05:00
parent d435f0ae41
commit 6a35662ebb
2 changed files with 29 additions and 18 deletions

View File

@@ -1,20 +1,29 @@
### 💕 GitHub Sponsors <!--header-->
The *sponsors* plugin lets you display your sponsors and introduction text from [GitHub sponsors](https://github.com/sponsors/).
<table> <table>
<td align="center"> <tr><th colspan="2"><h3>💕 GitHub Sponsors</h3></th></tr>
<details open><summary>GitHub sponsors card</summary> <tr><td colspan="2" align="center"><p>This plugin displays sponsors and introduction text from <a href="https://github.com/sponsors/">GitHub sponsors</a>.</p>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg"> </td></tr>
</details> <tr>
<details><summary>GitHub sponsors full introduction</summary> <th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg"> <td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a></td>
</details> </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">
<details open><summary>GitHub sponsors card</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg" alt=""></img></details>
<details open><summary>GitHub sponsors full introduction</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg" alt=""></img></details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
</tr>
</table> </table>
<!--/header-->
#### ➡️ Available options ## ➡️ Available options
<!--options--> <!--options-->
<table> <table>
@@ -46,9 +55,7 @@ The *sponsors* plugin lets you display your sponsors and introduction text from
</table> </table>
<!--/options--> <!--/options-->
*[→ Full specification](metadata.yml)* ## Examples workflows
#### Examples workflows
<!--examples--> <!--examples-->
```yaml ```yaml

View File

@@ -1,5 +1,9 @@
name: "💕 GitHub Sponsors" name: "💕 GitHub Sponsors"
category: github category: github
description: This plugin displays sponsors and introduction text from [GitHub sponsors](https://github.com/sponsors/).
examples:
+GitHub sponsors card: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg
+GitHub sponsors full introduction: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg
index: 23 index: 23
supports: supports:
- user - user