doc(plugins/starlists): update
This commit is contained in:
@@ -1,15 +1,28 @@
|
|||||||
### 💫 Starlists
|
<!--header-->
|
||||||
|
|
||||||
The *starlists* plugin displays your recently star lists.
|
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<td align="center">
|
<tr><th colspan="2"><h3>💫 Starlists</h3></th></tr>
|
||||||
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.svg">
|
<tr><td colspan="2" align="center"><p>This plugin displays your star lists.</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><i>No tokens are required for this plugin</i></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2" align="center">
|
||||||
|
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.svg" alt=""></img>
|
||||||
<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>
|
||||||
@@ -18,7 +31,7 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_starlists</code></td>
|
<td nowrap="nowrap"><code>plugin_starlists</code></td>
|
||||||
<td rowspan="2"><p>Display star lists</p>
|
<td rowspan="2"><p>Enable starlists plugin</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -29,7 +42,7 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_starlists_limit</code></td>
|
<td nowrap="nowrap"><code>plugin_starlists_limit</code></td>
|
||||||
<td rowspan="2"><p>Number of star lists to display</p>
|
<td rowspan="2"><p>Display limit (star lists)</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -43,7 +56,7 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_starlists_limit_repositories</code></td>
|
<td nowrap="nowrap"><code>plugin_starlists_limit_repositories</code></td>
|
||||||
<td rowspan="2"><p>Number of repositories to display per star lists</p>
|
<td rowspan="2"><p>Display limit (repositories per star list)</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -57,7 +70,7 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_starlists_shuffle_repositories</code></td>
|
<td nowrap="nowrap"><code>plugin_starlists_shuffle_repositories</code></td>
|
||||||
<td rowspan="2"><p>Shuffle displayed repositories</p>
|
<td rowspan="2"><p>Shuffle data for varied outputs</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -68,7 +81,7 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_starlists_ignored</code></td>
|
<td nowrap="nowrap"><code>plugin_starlists_ignored</code></td>
|
||||||
<td rowspan="2"><p>Star lists to skip</p>
|
<td rowspan="2"><p>Skipped star lists (case insensitive)</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -79,7 +92,8 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_starlists_only</code></td>
|
<td nowrap="nowrap"><code>plugin_starlists_only</code></td>
|
||||||
<td rowspan="2"><p>Star lists to display</p>
|
<td rowspan="2"><p>Restrict display to specified star lists (case insensitive)</p>
|
||||||
|
<p>This option is equivalent to <code>plugin_starlists_ignored</code> with all star lists but the ones listed in this option</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -91,9 +105,7 @@ The *starlists* plugin displays your recently star lists.
|
|||||||
</table>
|
</table>
|
||||||
<!--/options-->
|
<!--/options-->
|
||||||
|
|
||||||
*[→ Full specification](metadata.yml)*
|
## ℹ️ Examples workflows
|
||||||
|
|
||||||
#### ℹ️ Examples workflows
|
|
||||||
|
|
||||||
<!--examples-->
|
<!--examples-->
|
||||||
```yaml
|
```yaml
|
||||||
|
|||||||
@@ -1,51 +1,50 @@
|
|||||||
name: "💫 Starlists"
|
name: "💫 Starlists"
|
||||||
category: github
|
category: github
|
||||||
|
description: This plugin displays your star lists.
|
||||||
|
examples:
|
||||||
|
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.svg
|
||||||
index: 24
|
index: 24
|
||||||
supports:
|
supports:
|
||||||
- user
|
- user
|
||||||
scopes: []
|
scopes: []
|
||||||
inputs:
|
inputs:
|
||||||
|
|
||||||
# Enable or disable plugin
|
|
||||||
plugin_starlists:
|
plugin_starlists:
|
||||||
description: Display star lists
|
description: Enable starlists plugin
|
||||||
type: boolean
|
type: boolean
|
||||||
default: no
|
default: no
|
||||||
|
|
||||||
# Number of star lists to display
|
|
||||||
plugin_starlists_limit:
|
plugin_starlists_limit:
|
||||||
description: Number of star lists to display
|
description: Display limit (star lists)
|
||||||
type: number
|
type: number
|
||||||
default: 2
|
default: 2
|
||||||
min: 1
|
min: 1
|
||||||
max: 100
|
max: 100
|
||||||
|
|
||||||
# Number of repositories to display per star lists
|
|
||||||
plugin_starlists_limit_repositories:
|
plugin_starlists_limit_repositories:
|
||||||
description: Number of repositories to display per star lists
|
description: Display limit (repositories per star list)
|
||||||
type: number
|
type: number
|
||||||
default: 2
|
default: 2
|
||||||
min: 0
|
min: 0
|
||||||
max: 100
|
max: 100
|
||||||
|
|
||||||
# Shuffle displayed repositories for varied outputs
|
|
||||||
plugin_starlists_shuffle_repositories:
|
plugin_starlists_shuffle_repositories:
|
||||||
description: Shuffle displayed repositories
|
description: Shuffle data for varied outputs
|
||||||
type: boolean
|
type: boolean
|
||||||
default: yes
|
default: yes
|
||||||
|
|
||||||
# List of star lists that will be ignored
|
|
||||||
plugin_starlists_ignored:
|
plugin_starlists_ignored:
|
||||||
description: Star lists to skip
|
description: Skipped star lists (case insensitive)
|
||||||
type: array
|
type: array
|
||||||
format: comma-separated
|
format: comma-separated
|
||||||
default: ""
|
default: ""
|
||||||
example: 😎 list1, 🥳 list2, ...
|
example: 😎 list1, 🥳 list2, ...
|
||||||
|
|
||||||
# List of star lists to display
|
|
||||||
# Using this option is equivalent of using "plugin_starlists_ignored" with all star lists but the ones listed
|
|
||||||
plugin_starlists_only:
|
plugin_starlists_only:
|
||||||
description: Star lists to display
|
description: |
|
||||||
|
Restrict display to specified star lists (case insensitive)
|
||||||
|
|
||||||
|
This option is equivalent to `plugin_starlists_ignored` with all star lists but the ones listed in this option
|
||||||
type: array
|
type: array
|
||||||
format: comma-separated
|
format: comma-separated
|
||||||
default: ""
|
default: ""
|
||||||
|
|||||||
Reference in New Issue
Block a user