diff --git a/source/plugins/discussions/README.md b/source/plugins/discussions/README.md index 72d69cfb..299dd248 100644 --- a/source/plugins/discussions/README.md +++ b/source/plugins/discussions/README.md @@ -1,15 +1,28 @@ -### đŸ’Ŧ Discussions - -The *discussions* plugin displays your GitHub discussions metrics. - + - + + + + + + + + + + + + + + +
- - -

đŸ’Ŧ Discussions

This plugin displays your GitHub discussions stats.

+
Supported features
→ Full specification
📗 Classic template
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+ + +
+ -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -18,7 +31,7 @@ The *discussions* plugin displays your GitHub discussions metrics. - @@ -28,7 +41,7 @@ The *discussions* plugin displays your GitHub discussions metrics. - @@ -39,21 +52,21 @@ The *discussions* plugin displays your GitHub discussions metrics. -
plugin_discussions

GitHub discussions metrics

+

Enable discussions plugin

plugin_discussions_categories

Display discussion categories

+

Toggle discussion categories display

plugin_discussions_categories_limit

Number of discussion categories to display

+

Display limit (categories)

+

Note that categories are sorted from highest to lowest count.

✨ On master/main
type: number
+zero behaviour: disable
default: 0
-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -67,4 +80,4 @@ with: plugin_discussions_categories_limit: 8 ``` - \ No newline at end of file + diff --git a/source/plugins/discussions/metadata.yml b/source/plugins/discussions/metadata.yml index 9a71d06f..e7bbb351 100644 --- a/source/plugins/discussions/metadata.yml +++ b/source/plugins/discussions/metadata.yml @@ -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 \ No newline at end of file + default: 0 + zero: disable \ No newline at end of file