metrics/source/plugins/introduction/README.md

🙋 Introduction

The introduction plugin display your account bio or your organization/repository description. It is mostly intended for metrics used outside of GitHub, since these informations are already available on GitHub.

For an user or an organization For a repository

➡️ Available options

Option	Type (format) [default] {allowed values}	Description
plugin_introduction	boolean [no]	Display account or repository introduction
plugin_introduction_title	boolean [yes]	Display introduction section title

Legend for option icons:

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

→ Full specification

ℹ️ Examples workflows

name: User introduction
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.introduction.svg
  token: ${{ secrets.METRICS_TOKEN }}
  user: github
  base: header
  plugin_introduction: 'yes'

name: Repository introduction
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.introduction.repository.svg
  token: ${{ secrets.METRICS_TOKEN }}
  template: repository
  repo: metrics
  base: header
  plugin_introduction: 'yes'