doc(plugins/discussions): update
This commit is contained in:
@@ -1,15 +1,28 @@
|
||||
### 💬 Discussions
|
||||
|
||||
The *discussions* plugin displays your GitHub discussions metrics.
|
||||
|
||||
<!--header-->
|
||||
<table>
|
||||
<td align="center">
|
||||
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg">
|
||||
<tr><th colspan="2"><h3>💬 Discussions</h3></th></tr>
|
||||
<tr><td colspan="2" align="center"><p>This plugin displays your GitHub discussions stats.</p>
|
||||
</td></tr>
|
||||
<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></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 src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg" alt=""></img>
|
||||
<img width="900" height="1" alt="">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/header-->
|
||||
|
||||
#### ➡️ Available options
|
||||
## ➡️ Available options
|
||||
|
||||
<!--options-->
|
||||
<table>
|
||||
@@ -18,7 +31,7 @@ The *discussions* plugin displays your GitHub discussions metrics.
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_discussions</code></td>
|
||||
<td rowspan="2"><p>GitHub discussions metrics</p>
|
||||
<td rowspan="2"><p>Enable discussions plugin</p>
|
||||
<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -28,7 +41,7 @@ The *discussions* plugin displays your GitHub discussions metrics.
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_discussions_categories</code></td>
|
||||
<td rowspan="2"><p>Display discussion categories</p>
|
||||
<td rowspan="2"><p>Toggle discussion categories display</p>
|
||||
<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -39,21 +52,21 @@ The *discussions* plugin displays your GitHub discussions metrics.
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap"><code>plugin_discussions_categories_limit</code></td>
|
||||
<td rowspan="2"><p>Number of discussion categories to display</p>
|
||||
<td rowspan="2"><p>Display limit (categories)</p>
|
||||
<p>Note that categories are sorted from highest to lowest count.</p>
|
||||
<img width="900" height="1" alt=""></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td nowrap="nowrap">✨ On <code>master</code>/<code>main</code><br>
|
||||
<b>type:</b> <code>number</code>
|
||||
<br>
|
||||
<b>zero behaviour:</b> disable</br>
|
||||
<b>default:</b> 0<br></td>
|
||||
</tr>
|
||||
</table>
|
||||
<!--/options-->
|
||||
|
||||
*[→ Full specification](metadata.yml)*
|
||||
|
||||
#### ℹ️ Examples workflows
|
||||
## ℹ️ Examples workflows
|
||||
|
||||
<!--examples-->
|
||||
```yaml
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
name: "💬 Discussions"
|
||||
category: github
|
||||
description: This plugin displays your GitHub discussions stats.
|
||||
examples:
|
||||
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg
|
||||
index: 16
|
||||
supports:
|
||||
- user
|
||||
@@ -7,21 +10,21 @@ scopes:
|
||||
- public_access
|
||||
inputs:
|
||||
|
||||
# Enable or disable plugin
|
||||
plugin_discussions:
|
||||
description: GitHub discussions metrics
|
||||
description: Enable discussions plugin
|
||||
type: boolean
|
||||
default: no
|
||||
|
||||
# Display discussion categories you have taken part in
|
||||
plugin_discussions_categories:
|
||||
description: Display discussion categories
|
||||
description: Toggle discussion categories display
|
||||
type: boolean
|
||||
default: yes
|
||||
|
||||
# Maximum number of categories to display (note that these are sorted desc)
|
||||
# Set to 0 to disable limitations
|
||||
plugin_discussions_categories_limit:
|
||||
description: Number of discussion categories to display
|
||||
description: |
|
||||
Display limit (categories)
|
||||
|
||||
Note that categories are sorted from highest to lowest count.
|
||||
type: number
|
||||
default: 0
|
||||
zero: disable
|
||||
Reference in New Issue
Block a user