From 705fb4ace48d52e282894715ed7cce8eff5cf718 Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Sat, 15 Jan 2022 21:59:23 -0500
Subject: [PATCH] doc(plugins/sponsors): update
---
source/plugins/sponsors/README.md | 8 ++++++--
source/plugins/sponsors/metadata.yml | 13 +++++++------
2 files changed, 13 insertions(+), 8 deletions(-)
diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md
index 219b9ede..83d0222f 100644
--- a/source/plugins/sponsors/README.md
+++ b/source/plugins/sponsors/README.md
@@ -32,7 +32,7 @@
plugin_sponsors |
- Display GitHub sponsors
+ | Enable sponsors plugin
![]() |
@@ -42,7 +42,11 @@
plugin_sponsors_sections |
- Sections to display
+ | Displayed sections
+
+goal: display GitHub active goal
+about: display GitHub sponsors introduction
+
![]() |
diff --git a/source/plugins/sponsors/metadata.yml b/source/plugins/sponsors/metadata.yml
index 0b42c106..32c248df 100644
--- a/source/plugins/sponsors/metadata.yml
+++ b/source/plugins/sponsors/metadata.yml
@@ -13,19 +13,20 @@ scopes:
- public_access
inputs:
- # Enable or disable plugin
plugin_sponsors:
- description: Display GitHub sponsors
+ description: Enable sponsors plugin
type: boolean
default: no
- # Sections to display
plugin_sponsors_sections:
- description: Sections to display
+ description: |
+ Displayed sections
+ - `goal`: display GitHub active goal
+ - `about`: display GitHub sponsors introduction
type: array
format: comma-separated
default: goal, about
example: goal, about
values:
- - goal # Display your GitHub active goal
- - about # Display your GitHub sponsors introduction
\ No newline at end of file
+ - goal
+ - about
\ No newline at end of file