Files
metrics/source/plugins/topics/README.md
2022-01-15 13:36:27 -05:00

2.6 KiB
Raw Blame History

📌 Starred topics

The topics plugin displays your starred topics. Check out GitHub topics to search interesting topics.

With icons
With labels

This uses puppeteer to navigate through your starred topics page.

➡️ Available options

TypeDescription
plugin_topics Display starred topics
type: boolean
default: no
plugin_topics_mode Plugin mode
type: string
default: starred
allowed values:
  • starred
  • icons
  • mastered
plugin_topics_sort Sorting method of starred topics
type: string
default: stars
allowed values:
  • stars
  • activity
  • starred
  • random
plugin_topics_limit Maximum number of topics to display
type: number (0 ≤ 𝑥 ≤ 20)
default: 15

→ Full specification

Examples workflows

name: Labels
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.topics.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_topics: 'yes'
  plugin_topics_limit: 12

name: Icons
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.topics.icons.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_topics: 'yes'
  plugin_topics_limit: 0
  plugin_topics_mode: icons