\n \n | Option | Description | \n
\n \n token
| \n GitHub Personal Access Token \nNo scopes are required by default, though some plugins and features may require additional scopes. \nWhen using a configuration which does not requires a GitHub PAT, it is possible to pass NOT_NEEDED instead.\nWhen doing so, any settings which defaults on user fetched values will not be templated (e.g. .user.*) and will usually need to be set manually. \n![\"\"]() | \n
\n \n ✔️ Required
\n🔐 Token
\ntype: token\n
| \n
\n \n user
| \n GitHub username \nDefaults to token owner username. \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\ntype: string\n
| \n
\n \n repo
| \n GitHub repository \nThis option is only revelant for repositories templates \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\ntype: string\n
| \n
\n \n committer_token
| \n GitHub Token used to commit metrics \nLeave this to ${{ github.token }} or ${{ secrets.GITHUB_TOKEN }}, which is a special auto-generated token restricted to current repository scope. \n\n💡 When using output_action: gist, it will use token instead, since gists are outside of scope \n \n![\"\"]() | \n
\n \n 🔐 Token
\ntype: token\n
\ndefault: ${{ github.token }}
| \n
\n \n committer_branch
| \n Target branch \nDefaults to current repository default branch \n![\"\"]() | \n
\n \n type: string\n
| \n
\n \n committer_message
| \n Commit message \nUse ${filename} to display filename \n![\"\"]() | \n
\n \n type: string\n
\ndefault: Update ${filename} - [Skip GitHub Action]
| \n
\n \n committer_gist
| \n Gist id \nSpecify an existing gist id (can be retrieved from its URL) when using output_action: gist. \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\ntype: string\n
| \n
\n \n filename
| \n Output path \nWhen using an asterisk (*), correct extension will automatically be applied according to config_output value \n![\"\"]() | \n
\n \n type: string\n
\ndefault: github-metrics.*
| \n
\n \n markdown
| \n Markdown template path \nIt can be either a local path or a full link (e.g. https://raw.githubusercontent.com) \n![\"\"]() | \n
\n \n type: string\n
\ndefault: TEMPLATE.md
| \n
\n \n markdown_cache
| \n Markdown file cache \n![\"\"]() | \n
\n \n type: string\n
\ndefault: .cache
| \n
\n \n output_action
| \n Output action \n\nnone: just create file in /metrics_renders directory of action runnercommit: push output to committer_branchpull-request: push output to a new branch and open a pull request to committer_branchpull-request-merge: same as pull-request and additionally merge pull requestpull-request-squash: same as pull-request and additionally squash and merge pull requestpull-request-rebase: same as pull-request and additionally rebase and merge pull requestgist: push output to committer_gist \n\n💡 When using pull-request, you will need to set the last job with a pull-request-* action instead, else it won't be merged \n \n\n⚠️ As GitHub gists API does not support binary files upload, gist does not support config_output set to either png, jpeg or markdown-pdf \n \n![\"\"]() | \n
\n \n type: string\n
\ndefault: commit
\nallowed values:- none
- commit
- pull-request
- pull-request-merge
- pull-request-squash
- pull-request-rebase
- gist
| \n
\n \n output_condition
| \n Output condition \n\nalways: always try to push changesdata-changed: skip changes if no data changed (e.g. like when only metadata changed) \n\nℹ️ This option is only revelant when config_output: svg is set \n \n![\"\"]() | \n
\n \n type: string\n
\ndefault: always
\nallowed values: | \n
\n \n optimize
| \n Optimization features \n\nTemplates may not always honour all provided options \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: css, xml
\nallowed values: | \n
\n \n setup_community_templates
| \n Community templates to setup \nSee community templates guide for more informations \n![\"\"]() | \n
\n \n 🌐 Web instances must configure settings.json:\n\n- metrics.setup.community.templates
\n \ntype: array\n(comma-separated)\n
| \n
\n \n template
| \n Template \nCommunity templates must be prefixed by at sign (@)\nSee list of supported templates \n![\"\"]() | \n
\n \n type: string\n
\ndefault: classic
| \n
\n \n query
| \n Query parameters \nPass additional parameters to templates.\nThis is mostly useful for custom templates. \n\n⚠️ Do not use this option to pass other existing parameters, they will be overwritten \n \n![\"\"]() | \n
\n \n type: json\n
\ndefault: → Click to expand{}
| \n
\n \n extras_css
| \n Extra CSS \nCustom CSS that will be injected in used template.\nUseful to avoid creating a new template just to tweak some styling \n\n💡 metrics tends to avoid using !important rules, which means that most styling can be overridden by this option when using !important \n \n![\"\"]() | \n
\n \n 🌐 Web instances must configure settings.json:\n\n- metrics.run.puppeteer.user.css
\n \ntype: string\n
| \n
\n \n extras_js
| \n Extra JavaScript \nCustom JavaScript that will be executed during puppeteer rendering.\nUseful to avoid creating a new template just to tweak some content. \n\n⚠️ Note that is it executed within puppeteer context and not within metrics context.\nNo access to fetched data or configuration will be offered through this context.\nIt is run after transformations and optimizations, but just before resizing. \n \n![\"\"]() | \n
\n \n 🌐 Web instances must configure settings.json:\n\n- metrics.run.puppeteer.user.js
\n \ntype: string\n
| \n
\n \n github_api_rest
| \n GitHub REST API endpoint \nCan be used to support GitHub enterprises server.\nLeave empty to use default endpoint. \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: string\n
| \n
\n \n github_api_graphql
| \n GitHub GraphQL API endpoint \nCan be used to support GitHub enterprises server.\nLeave empty to use default endpoint. \n\nℹ️ GraphQL octokit will automatically append /graphql to provided endpoint \n \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: string\n
| \n
\n \n config_timezone
| \n Timezone for dates \nSee list of supported timezone \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: string\n
| \n
\n \n config_order
| \n Plugin order \nBy default, templates use partials/_.json ordering.\nYou can override the content order by using this setting. \nIf some partials are omitted, they will be appended at the end with default ordering \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: array\n(comma-separated)\n
| \n
\n \n config_twemoji
| \n Use twemojis \nReplace emojis by twemojis to have a consistent render across all platforms\nMay increase filesize. \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: boolean\n
\ndefault: no
| \n
\n \n config_gemoji
| \n Use GitHub custom emojis \nGitHub supports additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...)\nSee full list at https://api.github.com/emojis. \nThis option has no effect when [`token: NOT_NEEDED``](/source/plugins/core/README.md#token) is set. \nMay increase filesize \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: boolean\n
\ndefault: yes
| \n
\n \n config_octicon
| \n Use GitHub octicons \nOcticons are open-sourced icons provided by GitHub.\nSee full list at https://primer.style/octicons. \nTo include an octicon, use the following syntax: :octicon-{name}-{size}:.\nSize must be a supported icon size (12, 16 or 24).\n16px octicons can omit size and directly use :octicon-{name}: syntax. \nMay increase filesize \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: boolean\n
\ndefault: no
| \n
\n \n config_display
| \n Display width (for image output formats) \n\nregular: 480px widthlarge: 960px width (may not be supported by all templates)columns: Full width with auto-sizing (two columns for desktops, and one column for mobile)\n \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: string\n
\ndefault: regular
\nallowed values: | \n
\n \n config_animations
| \n Use CSS animations \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: boolean\n
\ndefault: yes
| \n
\n \n config_base64
| \n Base64-encoded images \nEnable this option to make self-contained output (i.e. with no external links) \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: boolean\n
\ndefault: yes
| \n
\n \n config_padding
| \n Output padding \nAlthough metrics try to auto-guess resulting height, rendering is still dependent on OS and browser settings.\nIt can result in cropped or oversized outputs. \nThis settings let you manually adjust padding with the following format: \n\n- 1 value for both width and height
\n- 2 values for width fist and height second, separated by a comma (
,) \n \nEach value need to respect the following format: \n\n{number}{number} + {number}%{number}% \nPercentage are relative to computed dimensions \n![\"\"]() | \n
\n \n type: string\n
\ndefault: 0, 8 + 11%
| \n
\n \n config_output
| \n Output format \n\nauto: Template default (usually svg or markdown)svg: SVG imagepng: PNG image (animations not supported)jpeg: JPEG image (animations and transparency not supported)json: JSON data dumpmarkdown: Markdown rendered filemarkdown-pdf: PDF from markdown rendered fileinsights: Metrics Insights self-contained HTML file (not configurable) \n![\"\"]() | \n
\n \n type: string\n
\ndefault: auto
\nallowed values:- auto
- svg
- png
- jpeg
- json
- markdown
- markdown-pdf
- insights
| \n
\n \n config_presets
| \n Configuration presets \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🌐 Web instances must configure settings.json:\n\n- metrics.setup.community.presets
\n \ntype: array\n(comma-separated)\n
| \n
\n \n retries
| \n Retries in case of failures (for rendering) \n![\"\"]() | \n
\n \n type: number\n(1 ≤\n𝑥\n≤ 10)\n
\ndefault: 3
| \n
\n \n retries_delay
| \n Delay between each retry (in seconds, for rendering) \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 3600)\n
\ndefault: 300
| \n
\n \n retries_output_action
| \n Retries in case of failures (for output action) \n![\"\"]() | \n
\n \n type: number\n(1 ≤\n𝑥\n≤ 10)\n
\ndefault: 5
| \n
\n \n retries_delay_output_action
| \n Delay between each retry (in seconds, for output action) \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 3600)\n
\ndefault: 120
| \n
\n \n clean_workflows
| \n Clean previous workflows jobs \nThis can be used to clean up Action tabs from previous workflows runs. \nUse all to clean up workflows runs in any state. \n\n⚠️ When reporting issues, it is required to provide logs so it can be investigated and reproduced.\nBe sure to disable this option when asking for help or submitting bug reports. \n \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\ntype: array\n(comma-separated)\n
\nallowed values:- cancelled
- failure
- success
- skipped
- startup_failure
- timed_out
- all
| \n
\n \n delay
| \n Job delay \nThis can be used to avoid triggering GitHub abuse mechanics on large workflows \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 3600)\n
\ndefault: 0
| \n
\n \n quota_required_rest
| \n Minimum GitHub REST API requests quota required to run \nAction will cancel itself without any errors if requirements are not met \nThis option has no effect when token: NOT_NEEDED is set \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 5000)\n
\ndefault: 200
| \n
\n \n quota_required_graphql
| \n Minimum GitHub GraphQL API requests quota required to run \nAction will cancel itself without any errors if requirements are not met \nThis option has no effect when token: NOT_NEEDED is set \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 5000)\n
\ndefault: 200
| \n
\n \n quota_required_search
| \n Minimum GitHub Search API requests quota required to run \nAction will cancel itself without any errors if requirements are not met \nThis option has no effect when token: NOT_NEEDED is set \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 30)\n
\ndefault: 0
| \n
\n \n notice_releases
| \n Notice about new releases of metrics \n![\"\"]() | \n
\n \n type: boolean\n
\ndefault: yes
| \n
\n \n use_prebuilt_image
| \n Use pre-built docker image from GitHub container registry \nIt allows to save build time and make job significantly faster, and there is almost no reason to disable this settings.\nThis option has no effects on forks (images will always be rebuilt from Dockerfile) \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: boolean\n
\ndefault: yes
| \n
\n \n plugins_errors_fatal
| \n Fatal plugin errors \nWhen enabled, the job will fail in case of plugin errors, else it will be handled gracefully in output with an error message \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: boolean\n
\ndefault: no
| \n
\n \n debug
| \n Debug mode \nThis setting is automatically enable if a job fail (useful with plugins_errors_fatal: yes) \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: boolean\n
\ndefault: no
| \n
\n \n verify
| \n SVG validity check \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\n🌐 Web instances must configure settings.json:\n\n- metrics.npm.optional.libxml2
\n \ntype: boolean\n
\ndefault: no
| \n
\n \n debug_flags
| \n Debug flags \n\n--cakeday: simulate registration anniversary--halloween: enable halloween colors (only first color scheme will be applied if multiple are specified)--winter: enable winter colors (only first color scheme will be applied if multiple are specified)--error: force render error--puppeteer-debug: enable puppeteer debug mode*--puppeteer-disable-headless: disable puppeteer headless mode (requires a graphical environment)*--puppeteer-wait-load: override puppeteer wait events*--puppeteer-wait-domcontentloaded: override puppeteer wait events*--puppeteer-wait-networkidle0: override puppeteer wait events*--puppeteer-wait-networkidle2: override puppeteer wait events* \n\n* 🌐 Web instances needs to have debug set in settings.json for these flags to be supported. \n \n\n⚠️ No backward compatibility is guaranteed for these features, they are only meant for debugging purposes. \n \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: array\n(space-separated)\n
\nallowed values:- --cakeday
- --halloween
- --winter
- --error
- --puppeteer-debug
- --puppeteer-disable-headless
- --puppeteer-wait-load
- --puppeteer-wait-domcontentloaded
- --puppeteer-wait-networkidle0
- --puppeteer-wait-networkidle2
| \n
\n \n debug_print
| \n Print output in console \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: boolean\n
\ndefault: no
| \n
\n \n dryrun
| \n Dry-run \n\n⚠️ Unlike output_action: none, output file won't be available in /metrics_renders directory \n \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: boolean\n
\ndefault: no
| \n
\n \n experimental_features
| \n Experimental features \n\n⚠️ No backward compatibility is guaranteed for these features \n \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: array\n(space-separated)\n
\nallowed values: | \n
\n \n use_mocked_data
| \n Use mocked data instead of live APIs \n![\"\"]() | \n
\n \n ⏯️ Cannot be preset
\n🔧 For development
\ntype: boolean\n
\ndefault: no
| \n
\n
\n\n","source/plugins/discussions/README.md":"\n\n \n | Option | Description | \n
\n \n plugin_languages
| \n Enable languages plugin \n![\"\"]() | \n
\n \n type: boolean\n
\ndefault: no
| \n
\n \n plugin_languages_ignored
| \n Ignored languages \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
| \n
\n \n plugin_languages_skipped
| \n Skipped repositories \n![\"\"]() | \n
\n \n ⏩ Inherits repositories_skipped
\ntype: array\n(newline-separated)\n
| \n
\n \n plugin_languages_limit
| \n Display limit \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 8)\n
\nzero behaviour: disable\ndefault: 8
| \n
\n \n plugin_languages_threshold
| \n Display threshold (percentage) \n![\"\"]() | \n
\n \n type: string\n
\ndefault: 0%
| \n
\n \n plugin_languages_other
| \n Group unknown, ignored and over-limit languages into "Other" category \nIf this option is enabled, "Other" category will not be subject to plugin_languages_threshold.\nIt will be automatically hidden if empty. \n![\"\"]() | \n
\n \n type: boolean\n
\ndefault: no
| \n
\n \n plugin_languages_colors
| \n Custom languages colors \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: github
| \n
\n \n plugin_languages_aliases
| \n Custom languages names \n![\"\"]() | \n
\n \n type: string\n
| \n
\n \n plugin_languages_sections
| \n Displayed sections \nNote that recently-used is only available when plugin_languages_indepth is enabled \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: most-used
\nallowed values: | \n
\n \n plugin_languages_details
| \n Additional details \nNote that lines is only available when plugin_languages_indepth is enabled \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\nallowed values:- bytes-size
- percentage
- lines
| \n
\n \n plugin_languages_indepth
| \n Indepth mode \n\n⚠️ read documentation first \n \n![\"\"]() | \n
\n \n 🌐 Web instances must configure settings.json:\n\n- metrics.cpu.overuse
\n- metrics.run.tempdir
\n- metrics.run.git
\n \ntype: boolean\n
\ndefault: false
| \n
\n \n plugin_languages_indepth_custom
| \n Indepth mode - Custom repositories \nSpecify a list of additional repositories to analyze. \nBelow are the supported syntax formats: \n\nowner/repo (e.g. lowlighter/metrics)owner/repo@branch (e.g. lowlighter/metrics@main)owner/repo@branch:commits (e.g. lowlighter/metrics@main:v1.0..v1.1)\n- See
git rev-list documentation for more information about commits syntax \n \n \nIt is possible to specify repositories that are not hosted on github.com by passing a full url instead.\nIn this case the repository must be accessible directly. \n\nℹ️ This option bypass plugin_languages_skipped \n \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
| \n
\n \n plugin_languages_analysis_timeout
| \n Indepth mode - Analysis timeout \n![\"\"]() | \n
\n \n type: number\n(1 ≤\n𝑥\n≤ 60)\n
\ndefault: 15
| \n
\n \n plugin_languages_analysis_timeout_repositories
| \n Indepth mode - Analysis timeout (repositories) \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 15)\n
\nzero behaviour: disable\ndefault: 7.5
| \n
\n \n plugin_languages_categories
| \n Indepth mode - Displayed categories (most-used section) \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: markup, programming
\nallowed values:- data
- markup
- programming
- prose
| \n
\n \n plugin_languages_recent_categories
| \n Indepth mode - Displayed categories (recently-used section) \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: markup, programming
\nallowed values:- data
- markup
- programming
- prose
| \n
\n \n plugin_languages_recent_load
| \n Indepth mode - Events to load (recently-used section) \n![\"\"]() | \n
\n \n type: number\n(100 ≤\n𝑥\n≤ 1000)\n
\ndefault: 300
| \n
\n \n plugin_languages_recent_days
| \n Indepth mode - Events maximum age (day, recently-used section) \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥\n≤ 365)\n
\nzero behaviour: disable\ndefault: 14
| \n
\n
\n\n\n## 🔎 `indepth` mode\n\nThe default algorithm uses the top languages from each repository you contributed to using GitHub GraphQL API (which is similar to the displayed languages bar on github.com). When working in collaborative projects with a lot of people, these numbers may be less representative of your actual work.\n\nThe `plugin_languages_indepth` option lets you use a more advanced algorithm for more accurate statistics.\nUnder the hood, it will clone your repositories, run [linguist-js](https://github.com/Nixinova/Linguist) (a JavaScript port of [GitHub linguist](https://github.com/github/linguist)) and iterate over patches matching your `commits_authoring` setting.\n\nSince git lets you use any email and username for commits, *metrics* may not be able to detect a commit ownership if it isn't the same as your GitHub personal data. By default, it will use your GitHub username, but you can configure additional matching usernames and email addresses using `commits_authoring` option.\n\n*Example: configuring `indepth` mode*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_indepth: yes\n commits_authoring: firstname lastname, username, username@users.noreply.github.com\n```\n\n> 💡 This feature unlocks the `lines` option in `plugin_languages_details`\n\n> ⚠️ This feature significantly increase workflow time\n\n> ⚠️ Since this mode iterates over **each matching commit of each repository**, it is not suited for large code base, especially those with a large amount of commits and the ones containing binaries. While `plugin_languages_analysis_timeout` and `plugin_languages_analysis_timeout_repositories` can be used to increase the default timeout for analysis, please be responsible and keep this feature disabled if it cannot work on your account to save GitHub resources and our planet 🌏\n\n> ⚠️ Although *metrics* does not send any code to external sources, repositories are temporarily cloned on the GitHub Action runner. It is advised to keep this option disabled when working with sensitive data or company code. Use at your own risk, *metrics* and its authors **cannot** be held responsible for any resulting code leaks. Source code is available for auditing at [analyzers.mjs](/source/plugins/languages/analyzers.mjs).\n\n> 🌐 Web instances must enable this feature in `settings.json`\n\nBelow is a summary of the process used to compute indepth statistics:\n\n## Most used mode\n\n1. Fetch GPG keys linked to your GitHub account\n - automatically add attached emails to `commits_authoring`\n - *web-flow* (GitHub's public key for changes made through web-ui) is also fetched\n2. Import GPG keys so they can be used to verify commits later\n3. Iterate through repositories\n - early break if `plugin_languages_analysis_timeout` is reached\n - skip repository if it matches `plugin_languages_skipped`\n - include repositories from `plugin_languages_indepth_custom`\n - a specific branch and commit range can be used\n - a source other than github.com can be used\n4. Clone repository\n - target branch is checkout\n5. List of authored commits is computed\n - using `git log --author` and `commits_authoring` to search in commit headers\n - using `git log --grep` and `commits_authoring` to search in commit body\n - ensure these are within the range specified by `plugin_languages_indepth_custom` (if applicable)\n6. Process authored commits\n - early break if `plugin_languages_analysis_timeout_repositories` is reached\n - using `git verify-commit` to check authenticity against imported GPG keys\n - using `git log --patch` to extract added/deleted lines/bytes from each file\n - using [GitHub linguist](https://github.com/github/linguist) ([linguist-js](https://github.com/Nixinova/LinguistJS)) to detect language for each file\n - respect `plugin_languages_categories` option\n - if a file has since been deleted or moved, checkout on the last commit file was present and run linguist again\n7. Aggregate results\n\n## Recently used mode\n\n1. Fetch push events linked to your account (or target repository)\n - matching `plugin_languages_recent_load` and `plugin_languages_recent_days` options\n - matching committer emails from `commits_authoring`\n2. Process authored commits\n - using [GitHub linguist](https://github.com/github/linguist) ([linguist-js](https://github.com/Nixinova/LinguistJS)) to detect language for each file\n - respect `plugin_languages_recent_categories` option\n - directly pass file content rather than performing I/O and simulating a git repository\n3. Aggregate results\n\n## 📅 Recently used languages\n\nThis feature uses a similar algorithm as `indepth` mode, but uses patches from your events feed instead.\nIt will fetch a specified amount of recent push events and perform linguistic analysis on it.\n\n> ⚠️ Note that *metrics* won't be able to use more events than GitHub API is able to provide\n\n*Example: display recently used languages from 400 GitHub events from last 2 weeks*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_sections: recently-used\n plugin_languages_recent_load: 400\n plugin_languages_recent_days: 14\n```\n\n> 🌐 Web instances must enable this feature in `settings.json`\n\n## 🥽 Controling which languages are displayed\n\nSeveral options lets you customize which languages should be displayed.\nIt is possible to ignore completely languages or those lower than a given threshold, skip repositories, and filter by language categories.\n\n*Example: hide HTML and CSS languages, skip lowlighter/metrics repository*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_ignored: html, css\n plugin_languages_skipped: lowlighter/metrics\n```\n\n*Example: hide languages with less than 2% usage*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_threshold: 2%\n```\n\n> 💡 The threshold feature will automatically scale remaining languages so the total percentage is always 100%. However, other stats like bytes count and lines are not affected.\n\nWhen using `indepth` mode, it is possible to hide languages per category.\nSupported categories are `data`, `markup`, `programming` and `prose`.\n\n*Example: hide data and prose languages from stats*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_categories: data, prose\n plugin_languages_recent_categories: data, prose\n```\n\n## 🎨 Using custom colors\n\nThe plugin uses GitHub language colors, but it may be hard to distinguish them depending on which languages you use.\nIt is possible to use custom colors using `plugin_languages_colors` option.\n\nThe following syntaxes are supported:\n- A predefined set from [colorsets.json](colorsets.json) *(support limited to 8 languages max)*\n- `${language}:${color}` to change the color of a language *(case insensitive)*\n- `${n}:${color}` to change the color of the n-th language\n\nBoth hexadecimal and [named color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) are supported.\n\n*Example: using a predefined color set*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_colors: rainbow\n plugin_languages_limit: 8\n```\n\n*Example: setting JavaScript to red, the first language to blue and the second one to `#ff00aa`*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_colors: javascript:red, 0:blue, 1:#ff00aa\n```\n\n## ✍️ Using custom languages name\n\nThis plugin is limited by [GitHub linguist](https://github.com/github/linguist) capabilities, meaning that some languages may be mislabeled in some cases.\n\nTo mitigate this, it is possible to use `plugin_languages_aliases` option and provide a list of overrides using the following syntax: `${language}:${alias}` *(case insensitive)*.\n\n*Example: display JavaScript as JS and TypeScript as TS*\n```yml\n- uses: lowlighter/metrics@latest\n with:\n plugin_languages: yes\n plugin_languages_aliases: javascript:JS typescript:TS\n```\n\n## ℹ️ Examples workflows\n\n\n```yaml\nname: Most used\nuses: lowlighter/metrics@latest\nwith:\n filename: metrics.plugin.languages.svg\n token: ${{ secrets.METRICS_TOKEN }}\n base: \"\"\n plugin_languages: yes\n plugin_languages_ignored: >-\n html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,\n gnuplot\n plugin_languages_limit: 4\n\n```\n```yaml\nname: Most used (with details)\nuses: lowlighter/metrics@latest\nwith:\n filename: metrics.plugin.languages.details.svg\n token: ${{ secrets.METRICS_TOKEN }}\n base: \"\"\n plugin_languages: yes\n plugin_languages_ignored: >-\n html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,\n gnuplot\n plugin_languages_details: bytes-size, percentage\n plugin_languages_limit: 4\n\n```\n```yaml\nname: Recently used\nuses: lowlighter/metrics@latest\nwith:\n filename: metrics.plugin.languages.recent.svg\n token: ${{ secrets.METRICS_TOKEN }}\n base: \"\"\n plugin_languages: yes\n plugin_languages_ignored: >-\n html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,\n gnuplot\n plugin_languages_sections: recently-used\n plugin_languages_details: bytes-size, percentage\n plugin_languages_limit: 4\n\n```\n```yaml\nname: Indepth analysis\nuses: lowlighter/metrics@latest\nwith:\n filename: metrics.plugin.languages.indepth.svg\n token: ${{ secrets.METRICS_TOKEN }}\n base: \"\"\n plugin_languages: yes\n plugin_languages_ignored: >-\n html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,\n gnuplot\n plugin_languages_indepth: yes\n plugin_languages_details: lines, bytes-size\n plugin_languages_limit: 4\n plugin_languages_analysis_timeout: 15\n\n```\n\n","source/plugins/leetcode/README.md":"\n\n \n | Option | Description | \n
\n \n base
| \n Base content \nThe following sections are supported: \n\nheader, which usually contains username, two-weeks commits calendars and a few additional dataactivity, which contains recent activity (commits, pull requests, issues, etc.)community, which contains community stats (following, sponsors, organizations, etc.)repositories, which contains repository stats (license, forks, stars, etc.)metadata, which contains information about generated metrics \nThese are all enabled by default, but it is possible to explicitly opt out from them. \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: header, activity, community, repositories, metadata
\nallowed values:- header
- activity
- community
- repositories
- metadata
| \n
\n \n base_indepth
| \n Indepth mode \nEnabling this will consume additional API queries to fetch more data.\nThis currently improves the accuracy of the following statistics: \n\n- total commits
\n- total issues
\n- total pull requests
\n- total pull requests reviews
\n- total repositories contributed to
\n \n![\"\"]() | \n
\n \n 🌐 Web instances must configure settings.json:\n\n- metrics.api.github.overuse
\n \ntype: boolean\n
\ndefault: no
| \n
\n \n base_hireable
| \n Show Available for hire! in header section \n![\"\"]() | \n
\n \n type: boolean\n
\ndefault: no
| \n
\n \n base_skip
| \n Skip base content \n\n⚠️ Any plugin that relies on base content data may break!\nOnly use this option when using a plugin that can be configured with token: NOT_NEEDED \n \n![\"\"]() | \n
\n \n type: boolean\n
\ndefault: no
| \n
\n \n repositories
| \n Fetched repositories \nA higher value result in more accurate metrics but can hit GitHub API rate-limit more easily (especially with a lot of plugins enabled) \n![\"\"]() | \n
\n \n type: number\n(0 ≤\n𝑥)\n
\ndefault: 100
| \n
\n \n repositories_batch
| \n Fetched repositories per query \nIf you receive Something went wrong while executing your query (which is usually caused by API timeouts), lowering this value may help.\nThis setting may not be supported by all plugins. \n![\"\"]() | \n
\n \n type: number\n(1 ≤\n𝑥\n≤ 100)\n
\ndefault: 100
| \n
\n \n repositories_forks
| \n Include forks \n![\"\"]() | \n
\n \n type: boolean\n
\ndefault: no
| \n
\n \n repositories_affiliations
| \n Repositories affiliations \n\nowner: owned repositoriescollaborator: repositories with push accessorganization_member: repositories from an organization where user is a member \nSome plugin outputs may be affected by this setting too. \nSet to "" to disable and fetch all repositories related to given account.\nBroad affiliations will result in less representative metrics. \n![\"\"]() | \n
\n \n type: array\n(comma-separated)\n
\ndefault: owner
\nallowed values:- owner
- collaborator
- organization_member
| \n
\n \n repositories_skipped
| \n Default skipped repositories \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: array\n(newline-separated)\n
| \n
\n \n users_ignored
| \n Default ignored users \nNote that emails are only supported in commits-related elements. \n![\"\"]() | \n
\n \n ⏭️ Global option
\ntype: array\n(comma-separated)\n
\ndefault: github-actions[bot], dependabot[bot], dependabot-preview[bot], actions-user, action@github.com
| \n
\n \n commits_authoring
| \n Identifiers that has been used for authoring commits \nSpecify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins \n![\"\"]() | \n
\n \n ⏭️ Global option
\n⏯️ Cannot be preset
\ntype: array\n(comma-separated)\n
\ndefault: → User login
| \n
\n
\n\n\n## ℹ️ Examples workflows\n\n\n```yaml\nname: Default metrics\nuses: lowlighter/metrics@latest\nwith:\n filename: metrics.base.svg\n token: ${{ secrets.METRICS_TOKEN }}\n base: header, activity, community, repositories, metadata\n\n```\n\n","source/plugins/calendar/README.md":"\n![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.achievements.compact.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.achievements.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.activity.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.characters.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.classic.svg\")
\n![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.organization.svg\")
\n![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.calendar.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.calendar.full.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.code.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.16personalities.svg\")
\n ![](\"/.github/readme/imgs/plugin_16personalities_profile.png\")
\n![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.chess.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.fortune.svg\")
\n ![\"\"](\"https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg\")
\n ![\"\"](\"https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.splatoon.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg\")
\n ![](\"https://user-images.githubusercontent.com/45036977/143533812-c2776bcc-1fda-441e-bc96-cf21d4c69ca1.jpg\")
\n![](\"https://user-images.githubusercontent.com/45036977/143533849-b7e03b4d-2903-4339-bbb7-e1fc0ea9724e.jpg\")
\n![](\"https://user-images.githubusercontent.com/45036977/143533856-f4a9fc0d-7bde-48c2-b579-e8ee91804d78.jpg\")
\n![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.contributors.categories.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.contributors.contributions.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.discussions.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.indepth.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.followup.user.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.gists.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.charts.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.habits.facts.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.introduction.repository.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.isocalendar.fullyear.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.isocalendar.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.indepth.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.recent.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.details.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.leetcode.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.ratio.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.lines.history.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.lines.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.playlist.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.recent.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.indepth.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.notable.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.detailed.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.screenshot.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.followers.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.people.repository.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.full.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.posts.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.projects.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.reactions.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.repositories.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.repositories.pinned.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.rss.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.skyline.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.skyline.city.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsors.full.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.sponsorships.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stackoverflow.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.graph.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stargazers.worldmap.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.starlists.languages.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stars.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.steam.full.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.support.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.icons.svg\"){kind=icon}
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.topics.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.traffic.svg\")
\n ![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.attachments.svg\")
![\"\"](\"https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.svg\")