Skip to content

Latest commit

 

History

History
129 lines (123 loc) · 4.13 KB

README.md

File metadata and controls

129 lines (123 loc) · 4.13 KB
← Back to plugins index

📌 Starred topics

This plugin displays starred topics.

Check out GitHub topics to search interesting topics.

⚠️ Disclaimer

This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub. All product and company names are trademarks™ or registered® trademarks of their respective holders.

Supported features
→ Full specification
📗 Classic template 📒 Markdown template
👤 Users
No tokens are required for this plugin
With icons
With labels

➡️ Available options

OptionDescription

plugin_topics

Enable topics plugin

🌐 Web instances must configure settings.json:
  • metrics.run.puppeteer.scrapping
type: boolean
default: no

plugin_topics_mode

Display mode

  • labels: display labels
  • icons: display icons (topics without icons will not be displayed)
  • starred: alias for labels
  • mastered: alias for icons
type: string
default: starred
allowed values:
  • labels
  • icons
  • starred
  • mastered

plugin_topics_sort

Sorting method

  • stars: sort by most stars
  • activity: sort by recent activity
  • starred: sort by starred date
  • random: sort randomly
type: string
default: stars
allowed values:
  • stars
  • activity
  • starred
  • random

plugin_topics_limit

Display limit

type: number (0 ≤ 𝑥 ≤ 20)
zero behaviour: disable
default: 15

ℹ️ Examples workflows

name: Labels
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.topics.svg
  token: NOT_NEEDED
  base: ""
  plugin_topics: yes
  plugin_topics_limit: 12
name: Icons
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.topics.icons.svg
  token: NOT_NEEDED
  base: ""
  plugin_topics: yes
  plugin_topics_limit: 0
  plugin_topics_mode: icons