From 1d5a8efea70777a06ce93508d82ca83dbe587f04 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sat, 15 Jan 2022 18:01:41 -0500 Subject: [PATCH] ci: auto-regenerate files --- README.md | 38 ++++---- settings.example.json | 2 +- source/plugins/README.md | 2 +- source/plugins/achievements/README.md | 21 +++-- source/plugins/activity/README.md | 27 ++++-- source/plugins/anilist/README.md | 21 +++-- source/plugins/base/README.md | 24 +++-- source/plugins/code/README.md | 18 ++-- source/plugins/contributors/README.md | 21 +++-- source/plugins/core/README.md | 117 ++++++++++++++++--------- source/plugins/discussions/README.md | 9 +- source/plugins/followup/README.md | 9 +- source/plugins/gists/README.md | 3 +- source/plugins/habits/README.md | 18 ++-- source/plugins/introduction/README.md | 6 +- source/plugins/isocalendar/README.md | 6 +- source/plugins/languages/README.md | 45 ++++++---- source/plugins/licenses/README.md | 12 ++- source/plugins/lines/README.md | 6 +- source/plugins/music/README.md | 30 ++++--- source/plugins/nightscout/README.md | 21 +++-- source/plugins/notable/README.md | 15 ++-- source/plugins/pagespeed/README.md | 15 ++-- source/plugins/people/README.md | 24 +++-- source/plugins/poopmap/README.md | 9 +- source/plugins/posts/README.md | 18 ++-- source/plugins/projects/README.md | 12 ++- source/plugins/reactions/README.md | 27 ++++-- source/plugins/repositories/README.md | 6 +- source/plugins/rss/README.md | 9 +- source/plugins/screenshot/README.md | 15 ++-- source/plugins/skyline/README.md | 15 ++-- source/plugins/sponsors/README.md | 6 +- source/plugins/stackoverflow/README.md | 18 ++-- source/plugins/stargazers/README.md | 3 +- source/plugins/starlists/README.md | 18 ++-- source/plugins/stars/README.md | 6 +- source/plugins/stock/README.md | 15 ++-- source/plugins/support/README.md | 3 +- source/plugins/traffic/README.md | 6 +- source/plugins/tweets/README.md | 15 ++-- source/plugins/wakatime/README.md | 21 +++-- tests/cases/starlists.plugin.yml | 1 + 43 files changed, 481 insertions(+), 252 deletions(-) diff --git a/README.md b/README.md index 554224fd..e753d819 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # πŸ“Š Metrics [](https://www.producthunt.com/posts/github-metrics?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-github-metrics) -[![Build, test, analyze and publish](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/workflow.yml) [![Metrics (examples)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml/badge.svg)](https://github.com/lowlighter/lowlighter/actions/workflows/metrics.yml) +[![Continuous integration](https://github.com/lowlighter/metrics/actions/workflows/ci.yml/badge.svg)](https://github.com/lowlighter/metrics/actions/workflows/ci.yml) Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories! @@ -21,7 +21,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -

🧩 Customizable with 38 plugins and 234 options!

+

🧩 Customizable with 38 plugins and 234 options!

@@ -47,15 +47,11 @@ Generate metrics that can be embedded everywhere, including your GitHub profile 🌟 Recently starred repositories - -
With icons - -
-
With labels - -
- - + +
With icons
+
With labels
+ + @@ -362,13 +358,13 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - 🎲 See also community plugins + 🎲 See also community plugins -

πŸ–ΌοΈ And even more with 4+ templates!

+

πŸ–ΌοΈ And even more with 4+ templates!

@@ -424,7 +420,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile Power user?
- Fork this repository and edit HTML, CSS, JS and for even more customization! + Fork this repository and edit HTML, CSS, JS and EJS for even more customization! @@ -448,14 +444,16 @@ There are several ways to setup metrics, each having its advantages and disadvan * [πŸ’• Using the shared instance *(~1 min)*](/.github/readme/partials/documentation/setup/shared.md) * βœ”οΈ Easily configurable and previewable * βž– Limited features *(compute-intensive features are disabled)* -* 🐳 Using command line with docker *(~5 min)* *(documentation not available yet)* +* [πŸ—οΈ Deploying a web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md) + * βœ”οΈ Create another shared instance + * βž– Requires some sysadmin knowlegde +* [🐳 Using command line with docker *(~5 min)*](/.github/readme/partials/documentation/setup/docker.md) * βœ”οΈ Suited for one-time rendering -* [πŸ—οΈ Deploying your own web instance *(~20 min)*](/.github/readme/partials/documentation/setup/web.md) - * βž– Mostly intended for development, or to create another shared instance +* [πŸ”§ Local setup for development *(~20 min)*](/.github/readme/partials/documentation/setup/local.md) Additional resources for setup: -* [🏦 Configuring metrics for organizations](/.github/readme/partials/documentation/organizations.md) -* 🧰 Template/Plugin compatibility matrix *(documentation not available yet)* +* [🏦 Configure metrics for organizations](/.github/readme/partials/documentation/organizations.md) +* [🧰 Template/Plugin compatibility matrix](/.github/readme/partials/documentation/compatibility.md) ## πŸ–ΌοΈ Templates Templates lets you change general appearance of rendered metrics. @@ -469,7 +467,7 @@ Templates lets you change general appearance of rendered metrics. ## 🧩 Plugins -Plugins provide additional content and lets you customize your rendered metrics. +Plugins provide additional content and lets you customize rendered metrics. **πŸ“¦ Maintained by core team** diff --git a/settings.example.json b/settings.example.json index db82df77..0f7308e4 100644 --- a/settings.example.json +++ b/settings.example.json @@ -39,7 +39,7 @@ "enabled": false, "//": "Enable languages plugin" }, "topics":{ - "enabled": false, "//": "Display starred topics" + "enabled": false, "//": "Enable topics plugin" }, "stars":{ "enabled": false, "//": "Display recently starred repositories" diff --git a/source/plugins/README.md b/source/plugins/README.md index c7083843..84a2d216 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -1,6 +1,6 @@ ## 🧩 Plugins -Plugins provide additional content and lets you customize your rendered metrics. +Plugins provide additional content and lets you customize rendered metrics. **πŸ“¦ Maintained by core team** diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index c22d3f3e..49f02b74 100644 --- a/source/plugins/achievements/README.md +++ b/source/plugins/achievements/README.md @@ -36,7 +36,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements - Display achievements +

Display achievements

+ type: boolean @@ -45,7 +46,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements_threshold - Display rank minimal threshold +

Display rank minimal threshold

+ type: string @@ -55,7 +57,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements_secrets - Display unlocked secrets achievements +

Display unlocked secrets achievements

+ type: boolean @@ -64,7 +67,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements_display - Achievements display style +

Achievements display style

+ type: string @@ -74,7 +78,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements_limit - Maximum number of achievements to display +

Maximum number of achievements to display

+ type: number @@ -85,7 +90,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements_ignored - Unlocked achievements to hide +

Unlocked achievements to hide

+ type: array @@ -94,7 +100,8 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, plugin_achievements_only - Unlocked achievements to display +

Unlocked achievements to display

+ type: array diff --git a/source/plugins/activity/README.md b/source/plugins/activity/README.md index 71e65dab..52a452c9 100644 --- a/source/plugins/activity/README.md +++ b/source/plugins/activity/README.md @@ -38,7 +38,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity - Display recent activity +

Display recent activity

+ type: boolean @@ -47,7 +48,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_limit - Maximum number of events to display +

Maximum number of events to display

+ type: number @@ -59,7 +61,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_load - Number of events to load +

Number of events to load

+ type: number @@ -71,7 +74,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_days - Maximum event age +

Maximum event age

+ type: number @@ -83,7 +87,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_filter - Events types to keep +

Events types to keep

+ type: array @@ -94,7 +99,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_visibility - Set events visibility +

Set events visibility

+ type: string @@ -104,7 +110,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_timestamps - Display events timestamps +

Display events timestamps

+ type: boolean @@ -113,7 +120,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_skipped - Repositories to skip +

Repositories to skip

+ ⏩ Inherits repositories_skipped
@@ -123,7 +131,8 @@ Use a full `repo` scope token to display **private** events. plugin_activity_ignored - Actors to ignore +

Actors to ignore

+ ⏩ Inherits users_ignored
diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index 87cbd369..78738039 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -34,7 +34,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist - Display data from your AniList account +

Display data from your AniList account

+ type: boolean @@ -43,7 +44,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist_medias - Medias types to display +

Medias types to display

+ type: array @@ -54,7 +56,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist_sections - Sections to display +

Sections to display

+ type: array @@ -65,7 +68,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist_limit - Maximum number of entries to display per section +

Maximum number of entries to display per section

+ type: number @@ -76,7 +80,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist_limit_characters - Maximum number of entries to display in characters section +

Maximum number of entries to display in characters section

+ type: number @@ -87,7 +92,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist_shuffle - Shuffle AniList data +

Shuffle AniList data

+ type: boolean @@ -96,7 +102,8 @@ These sections can also be filtered by media type, which can be either `anime`, plugin_anilist_user - AniList login +

AniList login

+ type: string diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index 04ac732a..e946e130 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -33,7 +33,8 @@ These are all enabled by default, but you can explicitely opt out from them. base - Metrics base content +

Metrics base content

+ type: array @@ -44,7 +45,8 @@ These are all enabled by default, but you can explicitely opt out from them. repositories - Number of repositories to use +

Number of repositories to use

+ type: number @@ -55,7 +57,8 @@ These are all enabled by default, but you can explicitely opt out from them. repositories_batch - Number of repositories to load at once by queries +

Number of repositories to load at once by queries

+ type: number @@ -67,7 +70,8 @@ These are all enabled by default, but you can explicitely opt out from them. repositories_forks - Include forks in metrics +

Include forks in metrics

+ type: boolean @@ -76,7 +80,8 @@ These are all enabled by default, but you can explicitely opt out from them. repositories_affiliations - Repositories affiliations +

Repositories affiliations

+ type: array @@ -87,7 +92,8 @@ These are all enabled by default, but you can explicitely opt out from them. repositories_skipped - Default repositories to skip +

Default repositories to skip

+ ⏭️ Global option
@@ -97,7 +103,8 @@ These are all enabled by default, but you can explicitely opt out from them. users_ignored - Default users to ignore +

Default users to ignore

+ ⏭️ Global option
@@ -109,7 +116,8 @@ These are all enabled by default, but you can explicitely opt out from them. commits_authoring - List of surnames or email addresses you use when authoring commits +

List of surnames or email addresses you use when authoring commits

+ ⏭️ Global option
diff --git a/source/plugins/code/README.md b/source/plugins/code/README.md index f658d4c5..cfdd5303 100644 --- a/source/plugins/code/README.md +++ b/source/plugins/code/README.md @@ -20,7 +20,8 @@ Display a random code snippet from your recent activity history. plugin_code - Display a random code snippet from recent activity +

Display a random code snippet from recent activity

+ type: boolean @@ -29,7 +30,8 @@ Display a random code snippet from your recent activity history. plugin_code_lines - Maximum number of line that a code snippet can contain +

Maximum number of line that a code snippet can contain

+ type: number @@ -38,7 +40,8 @@ Display a random code snippet from your recent activity history. plugin_code_load - Number of events to load +

Number of events to load

+ type: number @@ -50,7 +53,8 @@ Display a random code snippet from your recent activity history. plugin_code_visibility - Set events visibility +

Set events visibility

+ type: string @@ -60,7 +64,8 @@ Display a random code snippet from your recent activity history. plugin_code_skipped - Repositories to skip +

Repositories to skip

+ ⏩ Inherits repositories_skipped
@@ -70,7 +75,8 @@ Display a random code snippet from your recent activity history. plugin_code_languages - Restrict code snippet languages +

Restrict code snippet languages

+ type: array diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 30fc97f7..1f7a995f 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -43,7 +43,8 @@ Matching is performed in keys order. plugin_contributors - Display repository contributors +

Display repository contributors

+ type: boolean @@ -52,7 +53,8 @@ Matching is performed in keys order. plugin_contributors_base - Base reference +

Base reference

+ type: string @@ -60,7 +62,8 @@ Matching is performed in keys order. plugin_contributors_head - Head reference +

Head reference

+ type: string @@ -69,7 +72,8 @@ Matching is performed in keys order. plugin_contributors_ignored - Contributors to ignore +

Contributors to ignore

+ ⏩ Inherits users_ignored
@@ -80,7 +84,8 @@ Matching is performed in keys order. plugin_contributors_contributions - Display contributions +

Display contributions

+ type: boolean @@ -89,7 +94,8 @@ Matching is performed in keys order. plugin_contributors_sections - Sections to display +

Sections to display

+ type: array @@ -100,7 +106,8 @@ Matching is performed in keys order. plugin_contributors_categories - Contributions categories +

Contributions categories

+ 🌐 Web instances must configure settings.json
diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md index 51c35f03..b96d1bb5 100644 --- a/source/plugins/core/README.md +++ b/source/plugins/core/README.md @@ -11,7 +11,8 @@ Metrics also have general options that impact global metrics rendering. token - GitHub Personal Token +

GitHub Personal Token

+ βœ”οΈ Required
@@ -21,7 +22,8 @@ Metrics also have general options that impact global metrics rendering. user - GitHub username +

GitHub username

+ type: string @@ -29,7 +31,8 @@ Metrics also have general options that impact global metrics rendering. repo - GitHub repository +

GitHub repository

+ type: string @@ -37,7 +40,8 @@ Metrics also have general options that impact global metrics rendering. committer_token - GitHub Token used to commit metrics +

GitHub Token used to commit metrics

+ πŸ” Token
@@ -47,7 +51,8 @@ Metrics also have general options that impact global metrics rendering. committer_branch - Branch used to commit rendered metrics +

Branch used to commit rendered metrics

+ type: string @@ -55,7 +60,8 @@ Metrics also have general options that impact global metrics rendering. committer_message - Commit message +

Commit message

+ type: string @@ -64,7 +70,8 @@ Metrics also have general options that impact global metrics rendering. committer_gist - Gist used to store metrics +

Gist used to store metrics

+ type: string @@ -72,7 +79,8 @@ Metrics also have general options that impact global metrics rendering. filename - Rendered metrics output path +

Rendered metrics output path

+ type: string @@ -81,7 +89,8 @@ Metrics also have general options that impact global metrics rendering. markdown - Rendered markdown output path +

Rendered markdown output path

+ type: string @@ -90,7 +99,8 @@ Metrics also have general options that impact global metrics rendering. markdown_cache - Rendered markdown file cache +

Rendered markdown file cache

+ type: string @@ -99,7 +109,8 @@ Metrics also have general options that impact global metrics rendering. output_action - Output action +

Output action

+ type: string @@ -109,7 +120,8 @@ Metrics also have general options that impact global metrics rendering. output_condition - Output condition +

Output condition

+ type: string @@ -119,7 +131,8 @@ Metrics also have general options that impact global metrics rendering. optimize - SVG optimization +

SVG optimization

+ type: array @@ -130,7 +143,8 @@ Metrics also have general options that impact global metrics rendering. setup_community_templates - Additional community templates to setup +

Additional community templates to setup

+ 🌐 Web instances must configure settings.json
@@ -140,7 +154,8 @@ Metrics also have general options that impact global metrics rendering. template - Template to use +

Template to use

+ type: string @@ -149,7 +164,8 @@ Metrics also have general options that impact global metrics rendering. query - Additional query parameters +

Additional query parameters

+ type: json @@ -158,7 +174,8 @@ Metrics also have general options that impact global metrics rendering. extras_css - Extra CSS +

Extra CSS

+ 🌐 Web instances must configure settings.json
@@ -167,7 +184,8 @@ Metrics also have general options that impact global metrics rendering. config_timezone - Timezone used +

Timezone used

+ ⏭️ Global option
@@ -176,7 +194,8 @@ Metrics also have general options that impact global metrics rendering. config_order - Configure content order +

Configure content order

+ ⏭️ Global option
@@ -186,7 +205,8 @@ Metrics also have general options that impact global metrics rendering. config_twemoji - Use twemojis instead of emojis +

Use twemojis instead of emojis

+ ⏭️ Global option
@@ -196,7 +216,8 @@ Metrics also have general options that impact global metrics rendering. config_gemoji - Use GitHub custom emojis +

Use GitHub custom emojis

+ ⏭️ Global option
@@ -206,7 +227,8 @@ Metrics also have general options that impact global metrics rendering. config_display - Render display width +

Render display width

+ ⏭️ Global option
@@ -217,7 +239,8 @@ Metrics also have general options that impact global metrics rendering. config_animations - SVG CSS animations +

SVG CSS animations

+ ⏭️ Global option
@@ -227,7 +250,8 @@ Metrics also have general options that impact global metrics rendering. config_base64 - Encode images links into base64 data +

Encode images links into base64 data

+ ⏭️ Global option
@@ -237,7 +261,8 @@ Metrics also have general options that impact global metrics rendering. config_padding - Image padding +

Image padding

+ type: string @@ -246,7 +271,8 @@ Metrics also have general options that impact global metrics rendering. config_output - Output image format +

Output image format

+ type: string @@ -256,7 +282,8 @@ Metrics also have general options that impact global metrics rendering. retries - Number of retries +

Number of retries

+ type: number @@ -268,7 +295,8 @@ Metrics also have general options that impact global metrics rendering. retries_delay - Time to wait (in seconds) before each retry +

Time to wait (in seconds) before each retry

+ type: number @@ -280,7 +308,8 @@ Metrics also have general options that impact global metrics rendering. retries_output_action - Number of retries (output action) +

Number of retries (output action)

+ type: number @@ -292,7 +321,8 @@ Metrics also have general options that impact global metrics rendering. retries_delay_output_action - Time to wait (in seconds) before each retry (output action) +

Time to wait (in seconds) before each retry (output action)

+ type: number @@ -304,7 +334,8 @@ Metrics also have general options that impact global metrics rendering. delay - Use this to avoid triggering abuse mechanics on large workflows +

Use this to avoid triggering abuse mechanics on large workflows

+ type: number @@ -316,7 +347,8 @@ Metrics also have general options that impact global metrics rendering. use_prebuilt_image - Use pre-built image from GitHub registry +

Use pre-built image from GitHub registry

+ type: boolean @@ -325,7 +357,8 @@ Metrics also have general options that impact global metrics rendering. plugins_errors_fatal - Die on plugins errors +

Die on plugins errors

+ πŸ”§ For development
@@ -335,7 +368,8 @@ Metrics also have general options that impact global metrics rendering. debug - Debug logs +

Debug logs

+ πŸ”§ For development
@@ -345,7 +379,8 @@ Metrics also have general options that impact global metrics rendering. verify - Verify SVG +

Verify SVG

+ πŸ”§ For development
@@ -355,7 +390,8 @@ Metrics also have general options that impact global metrics rendering. debug_flags - Debug flags +

Debug flags

+ πŸ”§ For development
@@ -366,7 +402,8 @@ Metrics also have general options that impact global metrics rendering. dryrun - Enable dry-run +

Enable dry-run

+ πŸ”§ For development
@@ -376,7 +413,8 @@ Metrics also have general options that impact global metrics rendering. experimental_features - Experimental features +

Experimental features

+ πŸ”§ For development
@@ -387,7 +425,8 @@ Metrics also have general options that impact global metrics rendering. use_mocked_data - Use mocked data instead of live APIs +

Use mocked data instead of live APIs

+ πŸ”§ For development
diff --git a/source/plugins/discussions/README.md b/source/plugins/discussions/README.md index 3f70b317..72d69cfb 100644 --- a/source/plugins/discussions/README.md +++ b/source/plugins/discussions/README.md @@ -18,7 +18,8 @@ The *discussions* plugin displays your GitHub discussions metrics. plugin_discussions - GitHub discussions metrics +

GitHub discussions metrics

+ type: boolean @@ -27,7 +28,8 @@ The *discussions* plugin displays your GitHub discussions metrics. plugin_discussions_categories - Display discussion categories +

Display discussion categories

+ ✨ On master/main
@@ -37,7 +39,8 @@ The *discussions* plugin displays your GitHub discussions metrics. plugin_discussions_categories_limit - Number of discussion categories to display +

Number of discussion categories to display

+ ✨ On master/main
diff --git a/source/plugins/followup/README.md b/source/plugins/followup/README.md index 07607764..22817edb 100644 --- a/source/plugins/followup/README.md +++ b/source/plugins/followup/README.md @@ -26,7 +26,8 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of plugin_followup - Display follow-up of repositories issues and pull requests +

Display follow-up of repositories issues and pull requests

+ type: boolean @@ -35,7 +36,8 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of plugin_followup_sections - Sections to display +

Sections to display

+ type: array @@ -46,7 +48,8 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of plugin_followup_indepth - Indepth follow-up processing +

Indepth follow-up processing

+ 🌐 Web instances must configure settings.json
diff --git a/source/plugins/gists/README.md b/source/plugins/gists/README.md index 21e083bd..68837910 100644 --- a/source/plugins/gists/README.md +++ b/source/plugins/gists/README.md @@ -18,7 +18,8 @@ The *gists* plugin displays your [gists](https://gist.github.com) metrics. plugin_gists - Display gists metrics +

Display gists metrics

+ type: boolean diff --git a/source/plugins/habits/README.md b/source/plugins/habits/README.md index 6fd610a7..7621b286 100644 --- a/source/plugins/habits/README.md +++ b/source/plugins/habits/README.md @@ -34,7 +34,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone plugin_habits - Display coding habits metrics +

Display coding habits metrics

+ type: boolean @@ -43,7 +44,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone plugin_habits_from - Number of events to use +

Number of events to use

+ type: number @@ -55,7 +57,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone plugin_habits_days - Maximum event age +

Maximum event age

+ type: number @@ -67,7 +70,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone plugin_habits_facts - Display coding habits collected facts based on recent activity +

Display coding habits collected facts based on recent activity

+ type: boolean @@ -76,7 +80,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone plugin_habits_charts - Display coding habits charts based on recent activity +

Display coding habits charts based on recent activity

+ 🌐 Web instances must configure settings.json
@@ -86,7 +91,8 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone plugin_habits_trim - Trim unused hours on daily chart +

Trim unused hours on daily chart

+ type: boolean diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md index d3eabaeb..01856f26 100644 --- a/source/plugins/introduction/README.md +++ b/source/plugins/introduction/README.md @@ -24,7 +24,8 @@ It is mostly intended for metrics used outside of GitHub, since these informatio plugin_introduction - Display account or repository introduction +

Display account or repository introduction

+ type: boolean @@ -33,7 +34,8 @@ It is mostly intended for metrics used outside of GitHub, since these informatio plugin_introduction_title - Display introduction section title +

Display introduction section title

+ type: boolean diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md index 88217079..c68060fe 100644 --- a/source/plugins/isocalendar/README.md +++ b/source/plugins/isocalendar/README.md @@ -31,7 +31,8 @@ plugin_isocalendar - Enable isocalendar plugin +

Enable isocalendar plugin

+ type: boolean @@ -40,7 +41,8 @@ plugin_isocalendar_duration - Time window +

Time window

+ type: string diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md index f46c96bb..9732ebd5 100644 --- a/source/plugins/languages/README.md +++ b/source/plugins/languages/README.md @@ -33,7 +33,8 @@ plugin_languages - Enable languages plugin +

Enable languages plugin

+ type: boolean @@ -42,7 +43,8 @@ plugin_languages_ignored - Ignored languages +

Ignored languages

+ type: array @@ -51,7 +53,8 @@ plugin_languages_skipped - Skipped repositories +

Skipped repositories

+ ⏩ Inherits repositories_skipped
@@ -61,7 +64,8 @@ plugin_languages_limit - Display limit +

Display limit

+ type: number @@ -74,7 +78,8 @@ plugin_languages_threshold - Display threshold (percentage) +

Display threshold (percentage)

+ type: string @@ -83,7 +88,8 @@ plugin_languages_colors - Custom languages colors +

Custom languages colors

+ type: array @@ -93,7 +99,8 @@ plugin_languages_aliases - Custom languages names +

Custom languages names

+ type: string @@ -101,7 +108,8 @@ plugin_languages_sections - Displayed sections +

Displayed sections

+ 🌐 Web instances must configure settings.json
@@ -113,7 +121,8 @@ plugin_languages_details - Additional details +

Additional details

+ 🌐 Web instances must configure settings.json
@@ -124,7 +133,8 @@ plugin_languages_indepth - Indepth mode (⚠️ read documentation first) +

Indepth mode (⚠️ read documentation first)

+ 🌐 Web instances must configure settings.json
@@ -134,7 +144,8 @@ plugin_languages_analysis_timeout - Indepth mode - Analysis timeout +

Indepth mode - Analysis timeout

+ 🌐 Web instances must configure settings.json
@@ -147,7 +158,8 @@ plugin_languages_categories - Indepth mode - Displayed categories (most-used section) +

Indepth mode - Displayed categories (most-used section)

+ 🌐 Web instances must configure settings.json
@@ -159,7 +171,8 @@ plugin_languages_recent_categories - Indepth mode - Displayed categories (recently-used section) +

Indepth mode - Displayed categories (recently-used section)

+ 🌐 Web instances must configure settings.json
@@ -171,7 +184,8 @@ plugin_languages_recent_load - Events to load (recently-used section) +

Events to load (recently-used section)

+ 🌐 Web instances must configure settings.json
@@ -184,7 +198,8 @@ plugin_languages_recent_days - Events maximum age (day, recently-used section) +

Events maximum age (day, recently-used section)

+ 🌐 Web instances must configure settings.json
diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index 1a70e263..d5a27169 100644 --- a/source/plugins/licenses/README.md +++ b/source/plugins/licenses/README.md @@ -33,7 +33,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l plugin_licenses - Display licenses informations +

Display licenses informations

+ 🌐 Web instances must configure settings.json
@@ -43,7 +44,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l plugin_licenses_setup - Command to setup target repository +

Command to setup target repository

+ type: string @@ -51,7 +53,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l plugin_licenses_ratio - Display used licenses ratio +

Display used licenses ratio

+ type: boolean @@ -60,7 +63,8 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l plugin_licenses_legal - Display legal informations about used licenses +

Display legal informations about used licenses

+ type: boolean diff --git a/source/plugins/lines/README.md b/source/plugins/lines/README.md index feabcab6..8b2b94e5 100644 --- a/source/plugins/lines/README.md +++ b/source/plugins/lines/README.md @@ -18,7 +18,8 @@ The *lines* of code plugin displays the number of lines of code you have added a plugin_lines - Display lines of code metrics +

Display lines of code metrics

+ type: boolean @@ -27,7 +28,8 @@ The *lines* of code plugin displays the number of lines of code you have added a plugin_lines_skipped - Repositories to skip +

Repositories to skip

+ ⏩ Inherits repositories_skipped
diff --git a/source/plugins/music/README.md b/source/plugins/music/README.md index 2781311f..b4d7579f 100644 --- a/source/plugins/music/README.md +++ b/source/plugins/music/README.md @@ -214,7 +214,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music - Display your music tracks +

Display your music tracks

+ type: boolean @@ -223,7 +224,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_provider - Music provider +

Music provider

+ type: string @@ -232,7 +234,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_token - Music provider personal token +

Music provider personal token

+ πŸ” Token
@@ -241,7 +244,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_mode - Plugin mode +

Plugin mode

+ type: string @@ -250,7 +254,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_playlist - Embed playlist url +

Embed playlist url

+ type: string @@ -258,7 +263,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_limit - Maximum number of tracks to display +

Maximum number of tracks to display

+ type: number @@ -270,7 +276,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_played_at - Display when the track was played +

Display when the track was played

+ type: boolean @@ -279,7 +286,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_time_range - Time period for top mode +

Time period for top mode

+ type: string @@ -289,7 +297,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_top_type - Whether to show tracks or artists in top mode +

Whether to show tracks or artists in top mode

+ type: string @@ -299,7 +308,8 @@ Click on the Name of any matching request. In the β€œHeaders” tab, scroll to t plugin_music_user - Music provider username +

Music provider username

+ type: string diff --git a/source/plugins/nightscout/README.md b/source/plugins/nightscout/README.md index 89042fd4..ae39da2e 100644 --- a/source/plugins/nightscout/README.md +++ b/source/plugins/nightscout/README.md @@ -25,7 +25,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout - Displays Blood Glucose +

Displays Blood Glucose

+ type: boolean @@ -34,7 +35,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout_url - Your Nightscout site URL +

Your Nightscout site URL

+ type: string @@ -43,7 +45,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout_datapoints - How many datapoints to show on the graph. 0 and 1 disable the graph. +

How many datapoints to show on the graph. 0 and 1 disable the graph.

+ type: number @@ -54,7 +57,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout_lowalert - When the blood sugar is considered low +

When the blood sugar is considered low

+ type: number @@ -65,7 +69,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout_highalert - When the blood sugar is considered high +

When the blood sugar is considered high

+ type: number @@ -76,7 +81,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout_urgentlowalert - When the blood sugar is considered urgently low +

When the blood sugar is considered urgently low

+ type: number @@ -87,7 +93,8 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a plugin_nightscout_urgenthighalert - When the blood sugar is considered urgently high +

When the blood sugar is considered urgently high

+ type: number diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md index c8ff86a0..ff2d833a 100644 --- a/source/plugins/notable/README.md +++ b/source/plugins/notable/README.md @@ -30,7 +30,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c plugin_notable - Display notable contributions in organizations +

Display notable contributions in organizations

+ type: boolean @@ -39,7 +40,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c plugin_notable_filter - Query filter +

Query filter

+ type: string @@ -47,7 +49,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c plugin_notable_from - Filter by repository host account type +

Filter by repository host account type

+ type: string @@ -57,7 +60,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c plugin_notable_repositories - Also display repository name +

Also display repository name

+ type: boolean @@ -66,7 +70,8 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c plugin_notable_indepth - Indepth notable contributions processing +

Indepth notable contributions processing

+ 🌐 Web instances must configure settings.json
diff --git a/source/plugins/pagespeed/README.md b/source/plugins/pagespeed/README.md index 311158b5..f8f1add6 100644 --- a/source/plugins/pagespeed/README.md +++ b/source/plugins/pagespeed/README.md @@ -35,7 +35,8 @@ Expect 10 to 30 seconds to generate the results. plugin_pagespeed - Display a website Google PageSpeed metrics +

Display a website Google PageSpeed metrics

+ type: boolean @@ -44,7 +45,8 @@ Expect 10 to 30 seconds to generate the results. plugin_pagespeed_url - Audited website +

Audited website

+ type: string @@ -53,7 +55,8 @@ Expect 10 to 30 seconds to generate the results. plugin_pagespeed_detailed - Detailed audit result +

Detailed audit result

+ type: boolean @@ -62,7 +65,8 @@ Expect 10 to 30 seconds to generate the results. plugin_pagespeed_screenshot - Display a screenshot of your website +

Display a screenshot of your website

+ type: boolean @@ -71,7 +75,8 @@ Expect 10 to 30 seconds to generate the results. plugin_pagespeed_token - PageSpeed token +

PageSpeed token

+ πŸ” Token
diff --git a/source/plugins/people/README.md b/source/plugins/people/README.md index f6829cb5..d3487cbd 100644 --- a/source/plugins/people/README.md +++ b/source/plugins/people/README.md @@ -42,7 +42,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people - Display GitHub users from various affiliations +

Display GitHub users from various affiliations

+ type: boolean @@ -51,7 +52,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_limit - Maximum number of user to display +

Maximum number of user to display

+ type: number @@ -62,7 +64,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_size - Size of displayed GitHub users' avatars +

Size of displayed GitHub users' avatars

+ type: number @@ -74,7 +77,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_types - Affiliations to display +

Affiliations to display

+ type: array @@ -85,7 +89,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_thanks - GitHub users to personally thanks +

GitHub users to personally thanks

+ type: array @@ -94,7 +99,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_sponsors_custom - Custom GitHub sponsors +

Custom GitHub sponsors

+ type: array @@ -103,7 +109,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_identicons - Use identicons instead of avatars +

Use identicons instead of avatars

+ type: boolean @@ -112,7 +119,8 @@ Sections will be ordered the same as specified in `plugin_people_types`. plugin_people_shuffle - Shuffle users +

Shuffle users

+ type: boolean diff --git a/source/plugins/poopmap/README.md b/source/plugins/poopmap/README.md index 52098e65..7eaca938 100644 --- a/source/plugins/poopmap/README.md +++ b/source/plugins/poopmap/README.md @@ -48,7 +48,8 @@ You now have your PoopMap token! This token will not expire and it can only acce plugin_poopmap - Display PoopMap stats +

Display PoopMap stats

+ type: boolean @@ -57,7 +58,8 @@ You now have your PoopMap token! This token will not expire and it can only acce plugin_poopmap_token - PoopMap API token +

PoopMap API token

+ πŸ” Token
@@ -66,7 +68,8 @@ You now have your PoopMap token! This token will not expire and it can only acce plugin_poopmap_days - PoopMap time range +

PoopMap time range

+ type: number diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md index df899d4f..20a14482 100644 --- a/source/plugins/posts/README.md +++ b/source/plugins/posts/README.md @@ -23,7 +23,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts - Display recent posts +

Display recent posts

+ type: boolean @@ -32,7 +33,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts_source - Posts external source +

Posts external source

+ type: string @@ -41,7 +43,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts_descriptions - Display posts descriptions +

Display posts descriptions

+ type: boolean @@ -50,7 +53,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts_covers - Display posts cover images +

Display posts cover images

+ type: boolean @@ -59,7 +63,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts_limit - Maximum number of posts to display +

Maximum number of posts to display

+ type: number @@ -71,7 +76,8 @@ The recent *posts* plugin displays recent articles you wrote on an external sour plugin_posts_user - Posts external source username +

Posts external source username

+ type: string diff --git a/source/plugins/projects/README.md b/source/plugins/projects/README.md index a31a4ebf..472eb409 100644 --- a/source/plugins/projects/README.md +++ b/source/plugins/projects/README.md @@ -49,7 +49,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th plugin_projects - Display active projects +

Display active projects

+ type: boolean @@ -58,7 +59,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th plugin_projects_limit - Maximum number of projects to display +

Maximum number of projects to display

+ type: number @@ -70,7 +72,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th plugin_projects_repositories - List of repository project identifiers to disaplay +

List of repository project identifiers to disaplay

+ type: array @@ -79,7 +82,8 @@ To do so, open your repository project and retrieve the last URL endpoint, in th plugin_projects_descriptions - Display projects descriptions +

Display projects descriptions

+ type: boolean diff --git a/source/plugins/reactions/README.md b/source/plugins/reactions/README.md index 9e04781c..7aa1b52d 100644 --- a/source/plugins/reactions/README.md +++ b/source/plugins/reactions/README.md @@ -18,7 +18,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions - Display average issue comments reactions +

Display average issue comments reactions

+ type: boolean @@ -27,7 +28,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_limit - Maximum number of issue comments to parse +

Maximum number of issue comments to parse

+ type: number @@ -39,7 +41,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_limit_issues - Maximum number of issues and pull requests opened to parse +

Maximum number of issues and pull requests opened to parse

+ type: number @@ -51,7 +54,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_limit_discussions - Maximum number of discussions opened to parse +

Maximum number of discussions opened to parse

+ type: number @@ -63,7 +67,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_limit_discussions_comments - Maximum number of discussions comments opened to parse +

Maximum number of discussions comments opened to parse

+ type: number @@ -75,7 +80,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_days - Maximum comments age +

Maximum comments age

+ type: number @@ -86,7 +92,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_display - Display mode +

Display mode

+ type: string @@ -96,7 +103,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_details - Additional details +

Additional details

+ type: array @@ -106,7 +114,8 @@ The *reactions* plugin displays overall reactions on your recent issues and issu plugin_reactions_ignored - Users to ignore +

Users to ignore

+ ⏩ Inherits users_ignored
diff --git a/source/plugins/repositories/README.md b/source/plugins/repositories/README.md index 6d563042..94ca6c29 100644 --- a/source/plugins/repositories/README.md +++ b/source/plugins/repositories/README.md @@ -22,7 +22,8 @@ Because of limitations of using SVG inside of `` tags, people won't be able plugin_repositories - Display chosen featured repositories +

Display chosen featured repositories

+ type: boolean @@ -31,7 +32,8 @@ Because of limitations of using SVG inside of `` tags, people won't be able plugin_repositories_featured - List of repositories to display +

List of repositories to display

+ type: array diff --git a/source/plugins/rss/README.md b/source/plugins/rss/README.md index fda4ad47..d81d6ddb 100644 --- a/source/plugins/rss/README.md +++ b/source/plugins/rss/README.md @@ -18,7 +18,8 @@ The *rss* plugin displays items from a specified RSS feed. plugin_rss - Display RSS feed +

Display RSS feed

+ type: boolean @@ -27,7 +28,8 @@ The *rss* plugin displays items from a specified RSS feed. plugin_rss_source - RSS feed source +

RSS feed source

+ type: string @@ -35,7 +37,8 @@ The *rss* plugin displays items from a specified RSS feed. plugin_rss_limit - Maximum number of items to display +

Maximum number of items to display

+ type: number diff --git a/source/plugins/screenshot/README.md b/source/plugins/screenshot/README.md index f0ed9c36..579770b3 100644 --- a/source/plugins/screenshot/README.md +++ b/source/plugins/screenshot/README.md @@ -19,7 +19,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d plugin_screenshot - Display a screenshot of any website +

Display a screenshot of any website

+ type: boolean @@ -28,7 +29,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d plugin_screenshot_title - Screenshot title caption +

Screenshot title caption

+ type: string @@ -37,7 +39,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d plugin_screenshot_url - Website to take screenshot +

Website to take screenshot

+ type: string @@ -45,7 +48,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d plugin_screenshot_selector - Selector to take in screenshot +

Selector to take in screenshot

+ type: string @@ -54,7 +58,8 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d plugin_screenshot_background - Display or remove default page background +

Display or remove default page background

+ type: boolean diff --git a/source/plugins/skyline/README.md b/source/plugins/skyline/README.md index ab58c421..6eaad0d0 100644 --- a/source/plugins/skyline/README.md +++ b/source/plugins/skyline/README.md @@ -22,7 +22,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to plugin_skyline - Display GitHub Skyline 3D calendar +

Display GitHub Skyline 3D calendar

+ type: boolean @@ -31,7 +32,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to plugin_skyline_year - Displayed year +

Displayed year

+ type: number @@ -42,7 +44,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to plugin_skyline_frames - Number of frames +

Number of frames

+ type: number @@ -54,7 +57,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to plugin_skyline_quality - Image quality +

Image quality

+ type: number @@ -66,7 +70,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to plugin_skyline_compatibility - Compatibility mode +

Compatibility mode

+ type: boolean diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md index dc696778..6c545b52 100644 --- a/source/plugins/sponsors/README.md +++ b/source/plugins/sponsors/README.md @@ -23,7 +23,8 @@ The *sponsors* plugin lets you display your sponsors and introduction text from plugin_sponsors - Display GitHub sponsors +

Display GitHub sponsors

+ type: boolean @@ -32,7 +33,8 @@ The *sponsors* plugin lets you display your sponsors and introduction text from plugin_sponsors_sections - Sections to display +

Sections to display

+ type: array diff --git a/source/plugins/stackoverflow/README.md b/source/plugins/stackoverflow/README.md index 908362a2..45c2bc4b 100644 --- a/source/plugins/stackoverflow/README.md +++ b/source/plugins/stackoverflow/README.md @@ -29,7 +29,8 @@ Your user id will be in both url and search bar. plugin_stackoverflow - Stackoverflow metrics +

Stackoverflow metrics

+ type: boolean @@ -38,7 +39,8 @@ Your user id will be in both url and search bar. plugin_stackoverflow_user - Stackoverflow user id +

Stackoverflow user id

+ type: number @@ -47,7 +49,8 @@ Your user id will be in both url and search bar. plugin_stackoverflow_sections - Sections to display +

Sections to display

+ type: array @@ -58,7 +61,8 @@ Your user id will be in both url and search bar. plugin_stackoverflow_limit - Maximum number of entries to display per section +

Maximum number of entries to display per section

+ type: number @@ -70,7 +74,8 @@ Your user id will be in both url and search bar. plugin_stackoverflow_lines - Maximum number of lines to display per question or answer +

Maximum number of lines to display per question or answer

+ type: number @@ -81,7 +86,8 @@ Your user id will be in both url and search bar. plugin_stackoverflow_lines_snippet - Maximum number of lines to display per code snippet +

Maximum number of lines to display per code snippet

+ type: number diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md index 3e4f52d8..bbbfc233 100644 --- a/source/plugins/stargazers/README.md +++ b/source/plugins/stargazers/README.md @@ -18,7 +18,8 @@ The *stargazers* plugin displays your stargazers evolution across all of your re plugin_stargazers - Display stargazers metrics +

Display stargazers metrics

+ type: boolean diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md index 62189d30..68f694ab 100644 --- a/source/plugins/starlists/README.md +++ b/source/plugins/starlists/README.md @@ -18,7 +18,8 @@ The *starlists* plugin displays your recently star lists. plugin_starlists - Display star lists +

Display star lists

+ ✨ On master/main
@@ -28,7 +29,8 @@ The *starlists* plugin displays your recently star lists. plugin_starlists_limit - Number of star lists to display +

Number of star lists to display

+ ✨ On master/main
@@ -41,7 +43,8 @@ The *starlists* plugin displays your recently star lists. plugin_starlists_limit_repositories - Number of repositories to display per star lists +

Number of repositories to display per star lists

+ ✨ On master/main
@@ -54,7 +57,8 @@ The *starlists* plugin displays your recently star lists. plugin_starlists_shuffle_repositories - Shuffle displayed repositories +

Shuffle displayed repositories

+ ✨ On master/main
@@ -64,7 +68,8 @@ The *starlists* plugin displays your recently star lists. plugin_starlists_ignored - Star lists to skip +

Star lists to skip

+ ✨ On master/main
@@ -74,7 +79,8 @@ The *starlists* plugin displays your recently star lists. plugin_starlists_only - Star lists to display +

Star lists to display

+ ✨ On master/main
diff --git a/source/plugins/stars/README.md b/source/plugins/stars/README.md index 5c72a3a4..3d1cf438 100644 --- a/source/plugins/stars/README.md +++ b/source/plugins/stars/README.md @@ -18,7 +18,8 @@ The *stars* plugin displays your recently starred repositories. plugin_stars - Display recently starred repositories +

Display recently starred repositories

+ type: boolean @@ -27,7 +28,8 @@ The *stars* plugin displays your recently starred repositories. plugin_stars_limit - Maximum number of stars to display +

Maximum number of stars to display

+ type: number diff --git a/source/plugins/stock/README.md b/source/plugins/stock/README.md index 1f537d2f..8d75be70 100644 --- a/source/plugins/stock/README.md +++ b/source/plugins/stock/README.md @@ -27,7 +27,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ plugin_stock - Display stock prices of a given company +

Display stock prices of a given company

+ type: boolean @@ -36,7 +37,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ plugin_stock_token - Yahoo Finance token +

Yahoo Finance token

+ πŸ” Token
@@ -45,7 +47,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ plugin_stock_symbol - Company stock symbol +

Company stock symbol

+ type: string @@ -53,7 +56,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ plugin_stock_duration - Time range to display +

Time range to display

+ type: string @@ -63,7 +67,8 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ plugin_stock_interval - Time intervals between records +

Time intervals between records

+ type: string diff --git a/source/plugins/support/README.md b/source/plugins/support/README.md index 6933d5a5..6e52bc45 100644 --- a/source/plugins/support/README.md +++ b/source/plugins/support/README.md @@ -20,7 +20,8 @@ An account on [GitHub Support Community](https://github.community/) is required plugin_support - GitHub Community Support metrics +

GitHub Community Support metrics

+ type: boolean diff --git a/source/plugins/traffic/README.md b/source/plugins/traffic/README.md index ab58bbd3..354a90b7 100644 --- a/source/plugins/traffic/README.md +++ b/source/plugins/traffic/README.md @@ -23,7 +23,8 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope plugin_traffic - Display repositories traffic metrics +

Display repositories traffic metrics

+ type: boolean @@ -32,7 +33,8 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope plugin_traffic_skipped - Repositories to skip +

Repositories to skip

+ ⏩ Inherits repositories_skipped
diff --git a/source/plugins/tweets/README.md b/source/plugins/tweets/README.md index 8aeeffc4..3000aba9 100644 --- a/source/plugins/tweets/README.md +++ b/source/plugins/tweets/README.md @@ -35,7 +35,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p plugin_tweets - Display recent tweets +

Display recent tweets

+ type: boolean @@ -44,7 +45,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p plugin_tweets_token - Twitter API token +

Twitter API token

+ πŸ” Token
@@ -53,7 +55,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p plugin_tweets_attachments - Display tweets attchments +

Display tweets attchments

+ type: boolean @@ -62,7 +65,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p plugin_tweets_limit - Maximum number of tweets to display +

Maximum number of tweets to display

+ type: number @@ -74,7 +78,8 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p plugin_tweets_user - Twitter username +

Twitter username

+ type: string diff --git a/source/plugins/wakatime/README.md b/source/plugins/wakatime/README.md index 3afe07e5..66420df6 100644 --- a/source/plugins/wakatime/README.md +++ b/source/plugins/wakatime/README.md @@ -29,7 +29,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime - Display WakaTime stats +

Display WakaTime stats

+ type: boolean @@ -38,7 +39,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime_token - WakaTime API token +

WakaTime API token

+ πŸ” Token
@@ -47,7 +49,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime_days - WakaTime time range +

WakaTime time range

+ type: string @@ -57,7 +60,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime_sections - Sections to display +

Sections to display

+ type: array @@ -67,7 +71,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime_limit - Maximum number of entries to display per graph +

Maximum number of entries to display per graph

+ type: number @@ -78,7 +83,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime_url - Address where to reach your Wakatime instance +

Address where to reach your Wakatime instance

+ type: string @@ -87,7 +93,8 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! plugin_wakatime_user - Your Wakatime user on the selfhosted Wakapi instance +

Your Wakatime user on the selfhosted Wakapi instance

+ type: string diff --git a/tests/cases/starlists.plugin.yml b/tests/cases/starlists.plugin.yml index ed71ce05..895f55cc 100644 --- a/tests/cases/starlists.plugin.yml +++ b/tests/cases/starlists.plugin.yml @@ -7,3 +7,4 @@ plugin_starlists_only: 🀘 TC39 use_mocked_data: 'yes' verify: 'yes' + timeout: 1800000