63 lines
1.7 KiB
YAML
63 lines
1.7 KiB
YAML
name: 💕 GitHub Sponsors
|
|
category: github
|
|
description: |
|
|
This plugin displays sponsors and introduction text from [GitHub sponsors](https://github.com/sponsors/).
|
|
examples:
|
|
+GitHub sponsors card: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg
|
|
GitHub sponsors full introduction: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg
|
|
index: 13
|
|
supports:
|
|
- user
|
|
- organization
|
|
- repository
|
|
scopes:
|
|
- read:user
|
|
- read:org
|
|
inputs:
|
|
|
|
plugin_sponsors:
|
|
description: |
|
|
Enable sponsors plugin
|
|
type: boolean
|
|
default: no
|
|
|
|
plugin_sponsors_sections:
|
|
description: |
|
|
Displayed sections
|
|
|
|
- `goal`: display GitHub active goal
|
|
- `about`: display GitHub sponsors introduction
|
|
- `list`: display GitHub sponsors list
|
|
type: array
|
|
format: comma-separated
|
|
default: goal, list, about
|
|
example: goal, list, about
|
|
values:
|
|
- goal
|
|
- about
|
|
- list
|
|
|
|
plugin_sponsors_past:
|
|
description: |
|
|
Past sponsorships
|
|
|
|
A [`token`](/source/plugins/core/README.md#token) from target [`user`](/source/plugins/core/README.md#user) must be specified to use this feature, as past sponsorships are gathered from sponsors activity which is private data.
|
|
|
|
> ⚠️ Past sponsorships does not respect sponsors privacy because of current GitHub API limitations. This may be fixed in a future release.
|
|
type: boolean
|
|
default: no
|
|
|
|
plugin_sponsors_size:
|
|
description: |
|
|
Profile picture display size
|
|
type: number
|
|
default: 24
|
|
min: 8
|
|
max: 64
|
|
|
|
plugin_sponsors_title:
|
|
description: |
|
|
Title caption
|
|
type: string
|
|
default: Sponsor Me!
|