plugin_achievementsplugin_achievements
Enable achievements plugin
plugin_achievementsplugin_achievementsEnable achievements plugin
plugin_achievements_thresholdplugin_achievements_thresholdDisplay rank threshold
Use X to display achievements not yet unlocked
plugin_achievements_secretsplugin_achievements_secretsDisplay secrets achievements
plugin_achievements_displayplugin_achievements_displayDisplay style
detailed: display icon, name, description and rankingplugin_achievements_limitplugin_achievements_limitDisplay limit
plugin_achievements_ignoredplugin_achievements_ignoredHide specified achievements
Use names without the rank adjective (i.e. without "great", "super" or "master")
plugin_achievements_onlyplugin_achievements_onlyRestrict display to specified achievements
Use names without the rank adjective (i.e. without "great", "super" or "master")
This option is equivalent to plugin_achievements_ignored with all existing achievements but the ones listed in this option
plugin_activityplugin_activityEnable activity plugin
plugin_activity_limitplugin_activity_limitDisplay limit
plugin_activity_loadplugin_activity_loadEvents to load
plugin_activity_daysplugin_activity_daysEvents maximum age
plugin_activity_visibilityplugin_activity_visibilityEvents visibility
Lets you hide private activity when using a repo scope token
plugin_activity_timestampsplugin_activity_timestampsDisplay events timestamps
plugin_activity_skippedplugin_activity_skippedSkipped repositories
plugin_activity_ignoredplugin_activity_ignoredIgnored users
Useful to ignore bots activity
plugin_activity_filterplugin_activity_filterEvents types
These are fetched from GitHub events API and the following types are currently supported:
plugin_anilistplugin_anilistEnable aniList plugin
plugin_anilist_mediasplugin_anilist_mediasDisplay medias types
plugin_anilist_sectionsplugin_anilist_sectionsDisplayed sections
favorites will display favorites plugin_anilist_mediasplugin_anilist_limitplugin_anilist_limitDisplay limit (medias)
plugin_anilist_limit_charactersplugin_anilist_limit_charactersDisplay limit (characters)
plugin_anilist_shuffleplugin_anilist_shuffleShuffle data for varied outputs
plugin_anilist_userplugin_anilist_userAniList login
basebaseBase content
The following sections are supported:
repositoriesrepositoriesRepositories to fetch
A higher value result in more accurate metrics but can hit GitHub API rate-limit more easily (especially with a lot of plugins enabled)
repositories_batchrepositories_batchRepositories to fetch at a time
If you receive Something went wrong while executing your query (which is usually caused by API timeout),
try lowering this value.
repositories_forksrepositories_forksInclude forks
repositories_affiliationsrepositories_affiliationsRepositories affiliations
owner: owned repositoriesrepositories_skippedrepositories_skippedDefault skipped repositories
users_ignoredusers_ignoredDefault ignored users
commits_authoringcommits_authoringIdentifiers that has been used for authoring commits
Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins
plugin_codeplugin_codeEnable code plugin
plugin_code_linesplugin_code_linesDisplay limit for code snippets
plugin_code_loadplugin_code_loadEvents to load
plugin_code_visibilityplugin_code_visibilityEvents visibility
Lets you hide private activity when using a repo scope token
plugin_code_skippedplugin_code_skippedSkipped repositories
plugin_code_languagesplugin_code_languagesRestrict display to specific languages
plugin_fortuneplugin_fortuneEnable fortune plugin
master/mainboolean
+ boolean
plugin_nightscoutplugin_nightscoutEnable nightscout plugin
plugin_nightscout_urlplugin_nightscout_urlNightscout URL
plugin_nightscout_datapointsplugin_nightscout_datapointsNumber of datapoints shown the graph
plugin_nightscout_lowalertplugin_nightscout_lowalertThreshold for low blood sugar
plugin_nightscout_highalertplugin_nightscout_highalertThreshold for high blood sugar
plugin_nightscout_urgentlowalertplugin_nightscout_urgentlowalertThreshold for urgently low blood sugar
plugin_nightscout_urgenthighalertplugin_nightscout_urgenthighalertThreshold for urgently high blood sugar
plugin_poopmapplugin_poopmapEnable poopmap plugin
plugin_poopmap_tokenplugin_poopmap_tokenPoopMap API token
plugin_poopmap_daysplugin_poopmap_daysTime range
plugin_screenshotplugin_screenshotEnable screenshot plugin
plugin_screenshot_title
+ plugin_screenshot_titleTitle caption
plugin_screenshot_url
+ plugin_screenshot_urlWebsite url
plugin_screenshot_selector
+ plugin_screenshot_selectorCSS Selector
plugin_screenshot_background
+ plugin_screenshot_backgroundDisplay background
plugin_stockplugin_stockEnable stock plugin
plugin_stock_tokenplugin_stock_tokenYahoo Finance token
plugin_stock_symbolplugin_stock_symbolCompany stock symbol
plugin_stock_durationplugin_stock_durationTime range (relative to current date)
1d: Todayplugin_stock_intervalplugin_stock_intervalTime interval between points
1m: 1 minuteplugin_contributorsplugin_contributorsEnable contributors plugin
plugin_contributors_baseplugin_contributors_baseBase reference (commit, tag, branch, etc.)
plugin_contributors_headplugin_contributors_headHead reference (commit, tag, branch, etc.)
plugin_contributors_ignoredplugin_contributors_ignoredIgnored users
Useful to ignore bots activity
plugin_contributors_contributionsplugin_contributors_contributionsToggle number of contributions display
plugin_contributors_sectionsplugin_contributors_sectionsDisplayed sections
contributors: all contributorsplugin_contributors_categoriesplugin_contributors_categoriesConfigure contribution categories
This option required plugin_contributors_sections to have categories in it to be effective
Pass a JSON object mapping category with fileglobs
tokentokenGitHub Personal Access Token
No scopes are required by default, though some plugins and features may require additional scopes
When using a configuration which does not requires a GitHub PAT, you may pass NOT_NEEDED instead.
@@ -392,7 +392,7 @@ Most of the time user option must also be set.
useruserGitHub username
Defaults to token owner username.
user option must also be set.
reporepoGitHub repository
This option is revevalant only for repositories templates
user option must also be set.
committer_tokencommitter_tokenGitHub Token used to commit metrics
Leave this to ${{ github.token }} or ${{ secrets.GITHUB_TOKEN }}, which is a special auto-generated token restricted to current repository scope.
@@ -429,7 +429,7 @@ Most of the timeuseroption must also be set. default: ${{ github.token }}
committer_branchcommitter_branchTarget branch
Default value is set to your repository default branch
user option must also be set.
committer_messagecommitter_messageCommit message
Use ${filename} to display filename
user option must also be set.
default: Update ${filename} - [Skip GitHub Action]committer_gistcommitter_gistGist id
Specify an existing gist id (can be retrieved from its URL) when using output_action: gist.
user option must also be set.
filenamefilenameOutput path
When using an asterisk (*), correct extension will automatically be applied according to config_output value
user option must also be set.
default: github-metrics.*markdownmarkdownMarkdown template path
It can be either a local path or a full link (e.g. https://raw.githubusercontent.com)
user option must also be set.
default: TEMPLATE.mdmarkdown_cachemarkdown_cacheMarkdown file cache
user option must also be set.
default: .cacheoutput_actionoutput_actionOutput action
none: just create file in /metrics_renders directory of action runneruser option must also be set.
allowed values:output_conditionoutput_conditionOutput condition
always: always try to push changesuser option must also be set.
allowed values:optimizeoptimizeOptimization features
css: purge and minify CSS stylesuser option must also be set.
allowed values:setup_community_templatessetup_community_templatesCommunity templates to setup
See community templates guide for more informations
user option must also be set.
templatetemplateTemplate
Community templates must be prefixed by at sign (@)
See list of supported templates
queryqueryQuery parameters
Pass additional parameters to templates. This is mostly useful for custom templates.
@@ -588,7 +588,7 @@ This is mostly useful for custom templates. default: {}extras_cssextras_cssExtra CSS
Custom CSS that will be injected in used template. Useful to avoid creating a new template just to tweak some styling
@@ -600,7 +600,7 @@ Useful to avoid creating a new template just to tweak some stylingextras_jsextras_jsExtra JavaScript
Custom JavaScript that will be executed during puppeteer rendering. Useful to avoid creating a new template just to tweak some content.
@@ -609,13 +609,12 @@ It is run after transformations and optimizations, but just before resizing.master/mainsettings.jsonsettings.jsonstring
config_timezoneconfig_timezoneTimezone for dates
See list of supported timezone
config_orderconfig_orderPlugin order
By default, templates use partials/_.json ordering.
You can override the content order by using this setting.
config_twemojiconfig_twemojiUse twemojis
Replace emojis by twemojis to have a consistent render across all platforms May increase filesize.
@@ -653,7 +652,7 @@ May increase filesize. default: noconfig_gemojiconfig_gemojiUse GitHub custom emojis
GitHub supports additional emojis which are not registered in Unicode standard (:octocat:, :shipit:, :trollface:, ...) See full list at https://api.github.com/emojis.
@@ -667,7 +666,7 @@ See full list at https://api.github.com/ default: yesconfig_displayconfig_displayDisplay width (for image output formats)
regular: 480px widthconfig_animationsconfig_animationsUse CSS animations
config_base64config_base64Base64-encoded images
Enable this option to make self-contained ouput (i.e. with no external links)
config_paddingconfig_paddingOutput padding
Although metrics try to auto-guess resulting height, rendering is still dependent on OS and browser settings. It can result in cropped or oversized outputs.
@@ -734,7 +733,7 @@ It can result in cropped or oversized outputs. default: 0, 8 + 11%config_outputconfig_outputOutput format
auto: Template default (usually svg or markdown)config_presetsconfig_presetsConfiguration presets
master/mainarray
(comma-separated)
retriesretriesRetries in case of failures (for rendering)
retries_delayretries_delayDelay between each retry (in seconds, for rendering)
retries_output_actionretries_output_actionRetries in case of failures (for output action)
retries_delay_output_actionretries_delay_output_actionDelay between each retry (in seconds, for output action)
delaydelayJob delay
This can be used to avoid triggering GitHub abuse mechanics on large workflows
use_prebuilt_imageuse_prebuilt_imageUse pre-built docker image from GitHub container registry
It allows to save build time and make job significantly faster, and there is almost no reason to disable this settings. This option has no effects on forks (images will always be rebuilt from Dockerfile)
@@ -847,7 +845,7 @@ This option has no effects on forks (images will always be rebuilt from Dockerfi default: yesplugins_errors_fatalplugins_errors_fatalFatal plugin errors
When enabled, the job will fail in case of plugin errors, else it will be handled gracefully in output with an error message
debugdebugDebug mode
This setting is automatically enable if a job fail (useful with plugins_errors_fatal: yes)
verifyverifySVG validity check
debug_flagsdebug_flagsDebug flags
--cakeday: simulate registration anniversarydebug_printdebug_printPrint output in console
master/mainboolean
dryrundryrunDry-run
Contrary to output_action: none, output file won't be available in /metrics_renders directory
experimental_featuresexperimental_featuresExperimental features
No backward compatibility is guaranteed for these features
use_mocked_datause_mocked_dataUse mocked data instead of live APIs
plugin_discussionsplugin_discussionsEnable discussions plugin
plugin_discussions_categoriesplugin_discussions_categoriesToggle discussion categories display
plugin_discussions_categories_limitplugin_discussions_categories_limitDisplay limit (categories)
Note that categories are sorted from highest to lowest count.
plugin_followupplugin_followupEnable followup plugin
plugin_followup_sectionsplugin_followup_sectionsDisplayed sections
repositories: overall status of issues and pull requests on your repositoriesplugin_followup_indepthplugin_followup_indepthIndepth analysis
plugin_gistsplugin_gistsEnable gists plugin
plugin_habitsplugin_habitsEnable habits plugin
plugin_habits_fromplugin_habits_fromEvents to use
A higher number will increase stats accuracy
plugin_habits_daysplugin_habits_daysEvent maximum age
plugin_habits_factsplugin_habits_factsToggle midly interesting facts display
It includes indentation type, average number of characters per line of code, and most active time and day
plugin_habits_chartsplugin_habits_chartsToggle charts display
It includes commit activity per hour of day and commit activity per day of week Recent language activity may also displayed (it requires extras features to be enabled for web instances) for historical reasons
@@ -92,7 +92,7 @@ Recent language activity may also displayed (it requires extras features to be e default: noplugin_habits_trimplugin_habits_trimTrim unused hours on charts
plugin_introductionplugin_introductionDisplay account or repository introduction
plugin_introduction_titleplugin_introduction_titleDisplay introduction section title
plugin_isocalendarplugin_isocalendarEnable isocalendar plugin
plugin_isocalendar_durationplugin_isocalendar_durationTime range
half-year: 180 daysplugin_languagesplugin_languagesEnable languages plugin
plugin_languages_ignoredplugin_languages_ignoredIgnored languages
plugin_languages_skippedplugin_languages_skippedSkipped repositories
plugin_languages_limitplugin_languages_limitDisplay limit
plugin_languages_thresholdplugin_languages_thresholdDisplay threshold (percentage)
plugin_languages_colorsplugin_languages_colorsCustom languages colors
plugin_languages_aliasesplugin_languages_aliasesCustom languages names
plugin_languages_sectionsplugin_languages_sectionsDisplayed sections
plugin_languages_detailsplugin_languages_detailsAdditional details
Note that lines is only available when plugin_languages_indepth is enabled
plugin_languages_indepthplugin_languages_indepthIndepth mode (⚠️ read documentation first)
plugin_languages_analysis_timeoutplugin_languages_analysis_timeoutIndepth mode - Analysis timeout
plugin_languages_categoriesplugin_languages_categoriesIndepth mode - Displayed categories (most-used section)
plugin_languages_recent_categoriesplugin_languages_recent_categoriesIndepth mode - Displayed categories (recently-used section)
plugin_languages_recent_loadplugin_languages_recent_loadEvents to load (recently-used section)
plugin_languages_recent_daysplugin_languages_recent_daysEvents maximum age (day, recently-used section)
plugin_licensesplugin_licensesEnable licenses plugin
plugin_licenses_setupplugin_licenses_setupSetup command
plugin_licenses_ratioplugin_licenses_ratioDisplay used licenses ratio
plugin_licenses_legalplugin_licenses_legalDisplay permissions, limitations and conditions about licenses
plugin_linesplugin_linesEnable lines plugin
plugin_lines_skippedplugin_lines_skippedSkipped repositories
plugin_musicplugin_musicEnable music plugin
plugin_music_providerplugin_music_providerMusic provider
apple: Apple Musicplugin_music_tokenplugin_music_tokenMusic provider token
Below is the expected token format for each provider:
plugin_music_modeplugin_music_modeDisplay mode
playlist: display random tracks from an URL playlistplugin_music_playlistplugin_music_playlistPlaylist URL
It must be from an "embed url" (i.e. music player iframes that can be integrated in other websites)
plugin_music_limitplugin_music_limitDisplay limit
plugin_music_played_atplugin_music_played_atRecently played - Toggle last played timestamp display
plugin_music_time_rangeplugin_music_time_rangeTop tracks - Time range for top mode
short: 4 weeksplugin_music_top_typeplugin_music_top_typeTop tracks - Display type
tracks: display trackplugin_music_userplugin_music_userMusic provider username
plugin_notableplugin_notableEnable notable plugin
plugin_notable_filterplugin_notable_filterQuery filter
Based on GitHub search syntax.
Supported fields are stars, forks and watchers
plugin_notable_skippedplugin_notable_skippedSkipped repositories
plugin_notable_fromplugin_notable_fromFilter by repository owner account type
all: no filteringplugin_notable_repositoriesplugin_notable_repositoriesToggle repository name display
Note that Repositories hosted by user account will always be fully displayed
plugin_notable_indepthplugin_notable_indepthIndepth mode
plugin_pagespeedplugin_pagespeedEnable pagespeed plugin
plugin_pagespeed_url
+ plugin_pagespeed_urlAudited website
plugin_pagespeed_detailed
+ plugin_pagespeed_detailedDetailed results
The following additional stats will be displayed:
plugin_pagespeed_screenshotplugin_pagespeed_screenshotDisplay a website screenshot
Significantly increase filesize
plugin_pagespeed_token
+ plugin_pagespeed_tokenPageSpeed token
Although not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See PageSpeed documentation for more informations.
plugin_peopleplugin_peopleEnable people plugin
plugin_people_limitplugin_people_limitDisplay limit
plugin_people_identiconsplugin_people_identiconsToggle identicons display
This can be used to mask user profile pictures for privacy
plugin_people_sizeplugin_people_sizeProfile picture display size
plugin_people_typesplugin_people_typesDisplayed sections (order is respected)
User and organization accounts support the following values:
plugin_people_thanksplugin_people_thanksSpecial thanks
This list can be used to thank specific users
plugin_people_sponsors_customplugin_people_sponsors_customCustom sponsors
This list can be used to add users from unsupported GitHub sponsors sources.
The option plugin_people_types must contain the sponsors section in order for this setting to be effective
plugin_people_types must contain the sponsorsplugin_people_shuffleplugin_people_shuffleShuffle data for varied output
This will fetch 10 times more data than plugin_people_limit to ensure output is always different
plugin_postsplugin_postsEnable posts plugin
plugin_posts_sourceplugin_posts_sourceExternal source
dev.to: dev.toplugin_posts_descriptionsplugin_posts_descriptionsToggle posts descriptions display
plugin_posts_coversplugin_posts_coversToggle posts cover images display
plugin_posts_limitplugin_posts_limitDisplay limit
plugin_posts_userplugin_posts_userExternal source username
plugin_projectsplugin_projectsEnable projects plugin
plugin_projects_limitplugin_projects_limitDisplay limit
Note that plugin_projects_repositories is not affected by this option
plugin_projects_repositoriesplugin_projects_repositoriesList of repositories projects
Use the following syntax for each project :user/:repo/projects/:project_id
plugin_projects_descriptionsplugin_projects_descriptionsToggle projects descriptions display
plugin_reactionsplugin_reactionsEnable reactions plugin
plugin_reactions_limitplugin_reactions_limitDisplay limit (issues and pull requests comments)
plugin_reactions_limit_issuesplugin_reactions_limit_issuesDisplay limit (issues and pull requests, first comment)
plugin_reactions_limit_discussionsplugin_reactions_limit_discussionsDisplay limit (discussions, first comment)
plugin_reactions_limit_discussions_commentsplugin_reactions_limit_discussions_commentsDisplay limit (discussions comments)
plugin_reactions_daysplugin_reactions_daysComments maximum age
plugin_reactions_displayplugin_reactions_displayDisplay mode
absolute: scale percentages using total reactions countplugin_reactions_detailsplugin_reactions_detailsAdditional details
plugin_reactions_ignoredplugin_reactions_ignoredIgnored users
Useful to ignore bots activity
plugin_repositoriesplugin_repositoriesEnable repositories plugin
plugin_repositories_featuredplugin_repositories_featuredList of featured repositories
If no owner is specified, it will implicitly use the current account login
plugin_rssplugin_rssEnable rss plugin
plugin_rss_sourceplugin_rss_sourceRSS feed source
plugin_rss_limitplugin_rss_limitDisplay limit
plugin_skylineplugin_skylineEnable skyline plugin
plugin_skyline_yearplugin_skyline_yearDisplayed year
plugin_skyline_framesplugin_skyline_framesFrames count
Use 120 for a full-loop and 60 for a half-loop. A higher number of frames will increase file size.
@@ -70,7 +70,7 @@ A higher number of frames will increase file size. default: 60plugin_skyline_qualityplugin_skyline_qualityImage quality
A higher image quality will increase file size.
plugin_skyline_compatibilityplugin_skyline_compatibilityCompatibility mode
This uses CSS animations rather than embedded GIF to support a widerr range of browser, like Firefox and Safari. Using this mode significantly increase file size as each frame is encoded separately
diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md index 8ee0ff84..94c1f230 100644 --- a/source/plugins/sponsors/README.md +++ b/source/plugins/sponsors/README.md @@ -31,7 +31,7 @@plugin_sponsorsplugin_sponsorsEnable sponsors plugin
plugin_sponsors_sectionsplugin_sponsors_sectionsDisplayed sections
goal: display GitHub active goalplugin_stackoverflowplugin_stackoverflowEnable stackoverflow plugin
plugin_stackoverflow_userplugin_stackoverflow_userStackoverflow user id
plugin_stackoverflow_sectionsplugin_stackoverflow_sectionsDisplayed sections
answers-top: display most popular answersplugin_stackoverflow_limitplugin_stackoverflow_limitDisplay limit (per section)
plugin_stackoverflow_linesplugin_stackoverflow_linesDisplay limit for questions and answers
Code snippets count as a single line and must be configured with plugin_stackoverflow_lines_snippet instead
plugin_stackoverflow_lines_snippetplugin_stackoverflow_lines_snippetDisplay limit for code snippets
plugin_stargazersplugin_stargazersEnable stargazers plugin
plugin_stargazers_charts_typeplugin_stargazers_charts_typeCharts display type
classic: <div> based charts, simple and lightweightmaster/mainstring
+ string
plugin_starlistsplugin_starlistsEnable starlists plugin
plugin_starlists_limitplugin_starlists_limitDisplay limit (star lists)
plugin_starlists_limit_repositoriesplugin_starlists_limit_repositoriesDisplay limit (repositories per star list)
plugin_starlists_shuffle_repositoriesplugin_starlists_shuffle_repositoriesShuffle data for varied outputs
plugin_starlists_ignoredplugin_starlists_ignoredSkipped star lists
This is case and emojis insensitive
plugin_starlists_onlyplugin_starlists_onlyRestrict display to specified star lists
This is case and emojis insensitive.
This option is equivalent to plugin_starlists_ignored with all star lists but the ones listed in this option
plugin_starsplugin_starsEnable stars plugin
plugin_stars_limitplugin_stars_limitDisplay limit
plugin_supportplugin_supportEnable support plugin
plugin_topicsplugin_topicsEnable topics plugin
plugin_topics_modeplugin_topics_modeDisplay mode:
labels: display labelsplugin_topics_sortplugin_topics_sortSorting method:
stars: sort by most starsplugin_topics_limitplugin_topics_limitDisplay limit
When using plugin_topics_mode: labels, an ellipsis will be displayed
plugin_trafficplugin_trafficEnable traffic plugin
plugin_traffic_skippedplugin_traffic_skippedSkipped repositories
plugin_tweetsplugin_tweetsEnable tweets plugin
plugin_tweets_tokenplugin_tweets_tokenTwitter API token
plugin_tweets_attachmentsplugin_tweets_attachmentsDisplay tweets attachments (images, video previews, etc.)
plugin_tweets_limitplugin_tweets_limitDisplay limit
plugin_tweets_userplugin_tweets_userTwitter username
plugin_wakatimeplugin_wakatimeEnable wakatime plugin
plugin_wakatime_tokenplugin_wakatime_tokenWakaTime API token
plugin_wakatime_daysplugin_wakatime_daysTime range
plugin_wakatime_sectionsplugin_wakatime_sectionsDisplayed sections
time: show total coding time and daily averageplugin_wakatime_limitplugin_wakatime_limitDisplay limit (per graph)
plugin_wakatime_urlplugin_wakatime_urlWakaTime url
Also compatible with self-hosted instance (wakapi)
plugin_wakatime_userplugin_wakatime_userWakaTime username