docs(plugins): clarification, fix typos and style

This commit is contained in:
lowlighter
2022-07-04 23:18:01 -04:00
parent 3c00e64c57
commit 52ca4d04b7
47 changed files with 733 additions and 408 deletions

View File

@@ -1,6 +1,7 @@
name: "💫 Starlists"
name: 💫 Star lists
category: github
description: This plugin displays your star lists.
description: |
This plugin displays star lists.
examples:
+repositories from star lists: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.svg
+languages from star lists: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.languages.svg
@@ -11,38 +12,46 @@ scopes: []
inputs:
plugin_starlists:
description: Enable starlists plugin
description: |
Enable starlists plugin
type: boolean
default: no
plugin_starlists_limit:
description: Display limit (star lists)
description: |
Display limit (star lists)
type: number
default: 2
min: 1
max: 100
plugin_starlists_limit_repositories:
description: Display limit (repositories per star list)
description: |
Display limit (repositories per star list)
type: number
default: 2
min: 0
max: 100
plugin_starlists_languages:
description: Toggle star list languages statistics
description: |
Star lists languages statistics
type: boolean
default: no
plugin_starlists_limit_languages:
description: Disply limit (languages per star list)
description: |
Display limit (languages per star list)
type: number
default: 8
min: 0
zero: disable
plugin_starlists_shuffle_repositories:
description: Shuffle data for varied outputs
description: |
Shuffle data
Can be used to create varied outputs
type: boolean
default: yes
@@ -50,7 +59,7 @@ inputs:
description: |
Skipped star lists
This is case and emojis insensitive
Case and emojis insensitive
type: array
format: comma-separated
default: ""
@@ -58,10 +67,11 @@ inputs:
plugin_starlists_only:
description: |
Restrict display to specified star lists
Showcased star lists
This is case and emojis insensitive.
This option is equivalent to `plugin_starlists_ignored` with all star lists but the ones listed in this option
Case and emojis insensitive.
Equivalent to [`plugin_starlists_ignored`](/source/plugins/starlists/README.md#plugin_starlists_ignored) with all star lists except the ones listed in this option
type: array
format: comma-separated
default: ""