sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

doc(plugins/introduction): update

Browse Source
This commit is contained in:
lowlighter
2022-01-15 21:19:55 -05:00
parent 86ed52f48c
commit 9153554c8e
2 changed files with 32 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
source/plugins/introduction/README.md
View File

@@ -1,21 +1,30 @@
### 🙋 Introduction <!--header-->
The *introduction* plugin display your account bio or your organization/repository description.
It is mostly intended for metrics used outside of GitHub, since these informations are already available on GitHub.
<table> <table>
<td align="center"> <tr><th colspan="2"><h3>🙋 Introduction</h3></th></tr>
<details open><summary>For an user or an organization</summary> <tr><td colspan="2" align="center"><p>This plugin displays account bio or organization/repository description.</p>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.svg"> <p>It is mostly intended for images that will be used outside of GitHub, since these informations are already displayed on GitHub.</p>
</details> </td></tr>
<details><summary>For a repository</summary> <tr>
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.repository.svg"> <th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
</details> <td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a></td>
<img width="900" height="1" alt=""> </tr>
</td> <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>For an user or an organization</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.svg" alt=""></img></details>
<details><summary>For a repository</summary><img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.repository.svg" alt=""></img></details>
<img width="900" height="1" alt="">
</td>
</tr>
</table> </table>
<!--/header-->
#### ➡️ Available options ## ➡️ Available options
<!--options--> <!--options-->
<table> <table>
@@ -45,9 +54,7 @@ It is mostly intended for metrics used outside of GitHub, since these informatio
</table> </table>
<!--/options--> <!--/options-->
*[→ Full specification](metadata.yml)* ## ℹ️ Examples workflows
#### ℹ️ Examples workflows
<!--examples--> <!--examples-->
```yaml ```yaml

7
source/plugins/introduction/metadata.yml
View File

@@ -1,5 +1,12 @@
name: "🙋 Introduction" name: "🙋 Introduction"
category: github category: github
description: |
This plugin displays account bio or organization/repository description.
It is mostly intended for images that will be used outside of GitHub, since these informations are already displayed on GitHub.
examples:
+for an user or an organization: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.svg
for a repository: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.repository.svg
index: 22 index: 22
supports: supports:
- user - user