Files
metrics/source/plugins/repositories/README.md

1.5 KiB
Raw Blame History

📓 Repositories

The repositories plugin can display a list of chosen featured repositories.

It is mostly intended for external usage as pinned repositories is probably a better alternative if you want to embed them on your profile.

Because of limitations of using SVG inside of <img> tags, people won't be able to click on it.

➡️ Available options

Option Type (format) [default] {allowed values} Description
plugin_repositories boolean [no] Display chosen featured repositories
plugin_repositories_featured array (comma-separated) [] List of repositories to display

Legend for option icons:

  • 🔐 Value should be stored in repository secrets
  • New feature currently in testing on master/main

→ Full specification

Examples workflows

name: Featured repositories
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.repositories.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_repositories: 'yes'
  plugin_repositories_featured: lowlighter/metrics