doc(plugins/stackoverflow): update

This commit is contained in:
lowlighter
2022-01-15 21:20:42 -05:00
parent 6a35662ebb
commit 294285eb39
2 changed files with 61 additions and 49 deletions

View File

@@ -1,5 +1,8 @@
name: "🗨️ Stackoverflow plugin"
name: "🗨️ StackOverflow plugin"
category: social
description: This plugin displays stats, questions and answer from [stackoverflow](https://stackoverflow.com/).
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stackoverflow.svg
index: 3
supports:
- user
@@ -7,52 +10,52 @@ supports:
scopes: []
inputs:
# Enable or disable plugin
plugin_stackoverflow:
description: Stackoverflow metrics
description: Enable stackoverflow plugin
type: boolean
default: no
# Stackoverflow user id
# To obtain it, extract the identifier on your account page url
plugin_stackoverflow_user:
description: Stackoverflow user id
type: number
default: 0
# Sections to display
plugin_stackoverflow_sections:
description: Sections to display
description: |
Displayed sections
- `answers-top`: display most popular answers
- `answers-recent`: display recent answers
- `questions-top`: display most popular questions
- `questions-recent`: display recent questions
type: array
format: comma-separated
default: answers-top, questions-recent
values:
- answers-top # Display top answers
- answers-recent # Display recent answers
- questions-top # Display top questions
- questions-recent # Display recent questions
- answers-top
- answers-recent
- questions-top
- questions-recent
# Number of entries to display per section
plugin_stackoverflow_limit:
description: Maximum number of entries to display per section
description: Display limit (per section)
type: number
default: 2
min: 1
max: 30
# Number of lines to display per question or answer
# Code snippets will take one line slot and should be configured with "plugin_stackoverflow_lines_snippet" instead
# Set to 0 to disable limitations
plugin_stackoverflow_lines:
description: Maximum number of lines to display per question or answer
description: |
Display limit for questions and answers
Code snippets count as a single line and must be configured with `plugin_stackoverflow_lines_snippet` instead
type: number
default: 4
min: 0
zero: disable
# Number of lines to display per code snippet
# Set to 0 to disable limitations
plugin_stackoverflow_lines_snippet:
description: Maximum number of lines to display per code snippet
description: Display limit for code snippets
type: number
default: 2
min: 0
zero: disable