diff --git a/README.md b/README.md index 928d9f0f..ffae1a0a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![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) -Generate metrics that can be embedded everywhere, including your GitHub profile readme! For users, organizations, and even repositories! +Generate metrics that can be embedded everywhere, including your GitHub profile readme! Supports users, organizations, and even repositories! @@ -29,30 +29,18 @@ Generate metrics that can be embedded everywhere, including your GitHub profile - - + + @@ -525,6 +513,7 @@ Plugins provide additional content and lets you customize your rendered metrics. * [💹 Stock prices](/source/plugins/stock/README.md) * [🐤 Latest tweets](/source/plugins/tweets/README.md) * [⏰ WakaTime plugin](/source/plugins/wakatime/README.md) + **🎲 Maintained by community** * [💉 Nightscout](/source/plugins/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [💩 PoopMap plugin](/source/plugins/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) diff --git a/settings.example.json b/settings.example.json index 9f3e7cfc..db82df77 100644 --- a/settings.example.json +++ b/settings.example.json @@ -33,10 +33,10 @@ "plugins.default": false, "//": "Default plugin state (advised to let 'false' unless in debug mode)", "plugins": { "//": "Global plugin configuration", "isocalendar":{ - "enabled": false, "//": "Display an isometric view of your commits calendar" + "enabled": false, "//": "Enable isocalendar plugin" }, "languages":{ - "enabled": false, "//": "Display most used languages metrics" + "enabled": false, "//": "Enable languages plugin" }, "topics":{ "enabled": false, "//": "Display starred topics" diff --git a/source/plugins/README.md b/source/plugins/README.md index 39397d53..c7083843 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -44,6 +44,7 @@ Plugins provide additional content and lets you customize your rendered metrics. * [💹 Stock prices](/source/plugins/stock/README.md) * [🐤 Latest tweets](/source/plugins/tweets/README.md) * [⏰ WakaTime plugin](/source/plugins/wakatime/README.md) + **🎲 Maintained by community** * [💉 Nightscout](/source/plugins/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [💩 PoopMap plugin](/source/plugins/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) diff --git a/source/plugins/achievements/README.md b/source/plugins/achievements/README.md index cfa64d74..9b11ddb2 100644 --- a/source/plugins/achievements/README.md +++ b/source/plugins/achievements/README.md @@ -30,17 +30,78 @@ It also lets you quickly see at a glance what this user primarly use GitHub for, #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_achievements` | `boolean` **[no]** | Display achievements | -| `plugin_achievements_threshold` | `string` **[C]** *{"S", "A", "B", "C", "X"}* | Display rank minimal threshold | -| `plugin_achievements_secrets` | `boolean` **[yes]** | Display unlocked secrets achievements | -| `plugin_achievements_display` | `string` **[detailed]** *{"detailed", "compact"}* | Achievements display style | -| `plugin_achievements_limit` | `number` **[0]** *{0 ≤ đ‘Ĩ}* | Maximum number of achievements to display | -| `plugin_achievements_ignored` | `array` *(comma-separated)* **[]** | Unlocked achievements to hide | -| `plugin_achievements_only` | `array` *(comma-separated)* **[]** | Unlocked achievements to display | - - +
🈷ī¸ Most used languages
-
Full year isometric calendar - -
-
Half year isometric calendar - -
- - 		-
Indepth analysis (clone and analyze repositories) - -
-
Recently used (analyze recent activity events) - -
-
Default algorithm - -
-
Default algorithm (with details) - -
- - 		+
Full year calendar
+
Half year calendar
+ + 		+
Indepth analysis (clone and analyze repositories)
+
Recently used (analyze recent activity events)
+
Default algorithm
+
Default algorithm (with details)
+ +
📌 Starred topics
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_achievementsDisplay achievements
type: boolean +
+default: no
plugin_achievements_thresholdDisplay rank minimal threshold
type: string +
+default: C
+allowed values:
  • S
  • A
  • B
  • C
  • X
plugin_achievements_secretsDisplay unlocked secrets achievements
type: boolean +
+default: yes
plugin_achievements_displayAchievements display style
type: string +
+default: detailed
+allowed values:
  • detailed
  • compact
plugin_achievements_limitMaximum number of achievements to display
type: number +
+(0 ≤ +đ‘Ĩ) +default: 0
plugin_achievements_ignoredUnlocked achievements to hide
type: array +(comma-separated) +
plugin_achievements_onlyUnlocked achievements to display
type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/activity/README.md b/source/plugins/activity/README.md index 1ba0747a..8b92a685 100644 --- a/source/plugins/activity/README.md +++ b/source/plugins/activity/README.md @@ -32,21 +32,105 @@ Use a full `repo` scope token to display **private** events. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_activity` | `boolean` **[no]** | Display recent activity | -| `plugin_activity_limit` | `number` **[5]** *{1 ≤ đ‘Ĩ ≤ 1000}* | Maximum number of events to display | -| `plugin_activity_load` | `number` **[300]** *{100 ≤ đ‘Ĩ ≤ 1000}* | Number of events to load | -| `plugin_activity_days` | `number` **[14]** *{0 ≤ đ‘Ĩ ≤ 365}* | Maximum event age | -| `plugin_activity_filter` | `array` *(comma-separated)* **[all]** *{"all", "comment", "ref/create", "ref/delete", "release", "push", "issue", "pr", "review", "wiki", "fork", "star", "member", "public"}* | Events types to keep | -| `plugin_activity_visibility` | `string` **[all]** *{"public", "all"}* | Set events visibility | -| `plugin_activity_timestamps` | `boolean` **[no]** | Display events timestamps | -| `plugin_activity_skipped` ⏊ | `array` *(comma-separated)* **[]** | Repositories to skip | -| `plugin_activity_ignored` ⏊ | `undefined` **[]** | Actors to ignore | - - -Legend for option icons: -* ⏊ Value inherits from its related global-level option + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_activityDisplay recent activity
type: boolean +
+default: no
plugin_activity_limitMaximum number of events to display
type: number +
+(1 ≤ +đ‘Ĩ +≤ 1000) +default: 5
plugin_activity_loadNumber of events to load
type: number +
+(100 ≤ +đ‘Ĩ +≤ 1000) +default: 300
plugin_activity_daysMaximum event age
type: number +
+(0 ≤ +đ‘Ĩ +≤ 365) +default: 14
plugin_activity_filterEvents types to keep
type: array +(comma-separated) +
+default: all
+allowed values:
  • all
  • comment
  • ref/create
  • ref/delete
  • release
  • push
  • issue
  • pr
  • review
  • wiki
  • fork
  • star
  • member
  • public
plugin_activity_visibilitySet events visibility
type: string +
+default: all
+allowed values:
  • public
  • all
plugin_activity_timestampsDisplay events timestamps
type: boolean +
+default: no
plugin_activity_skippedRepositories to skip
⏊ Inherits repositories_skipped
+type: array +(comma-separated) +
plugin_activity_ignoredActors to ignore
⏊ Inherits users_ignored
+type: undefined +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/anilist/README.md b/source/plugins/anilist/README.md index a5685005..1bd3606a 100644 --- a/source/plugins/anilist/README.md +++ b/source/plugins/anilist/README.md @@ -28,17 +28,82 @@ These sections can also be filtered by media type, which can be either `anime`, #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_anilist` | `boolean` **[no]** | Display data from your AniList account | -| `plugin_anilist_medias` | `array` *(comma-separated)* **[anime, manga]** *{"anime", "manga"}* | Medias types to display | -| `plugin_anilist_sections` | `array` *(comma-separated)* **[favorites]** *{"favorites", "watching", "reading", "characters"}* | Sections to display | -| `plugin_anilist_limit` | `number` **[2]** *{0 ≤ đ‘Ĩ}* | Maximum number of entries to display per section | -| `plugin_anilist_limit_characters` | `number` **[22]** *{0 ≤ đ‘Ĩ}* | Maximum number of entries to display in characters section | -| `plugin_anilist_shuffle` | `boolean` **[yes]** | Shuffle AniList data | -| `plugin_anilist_user` | `string` **[*→ User login*]** | AniList login | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_anilistDisplay data from your AniList account
type: boolean +
+default: no
plugin_anilist_mediasMedias types to display
type: array +(comma-separated) +
+default: anime, manga
+allowed values:
  • anime
  • manga
plugin_anilist_sectionsSections to display
type: array +(comma-separated) +
+default: favorites
+allowed values:
  • favorites
  • watching
  • reading
  • characters
plugin_anilist_limitMaximum number of entries to display per section
type: number +
+(0 ≤ +đ‘Ĩ) +default: 2
plugin_anilist_limit_charactersMaximum number of entries to display in characters section
type: number +
+(0 ≤ +đ‘Ĩ) +default: 22
plugin_anilist_shuffleShuffle AniList data
type: boolean +
+default: yes
plugin_anilist_userAniList login
type: string +
+default: → User login
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index ab6ec7d5..67d6f55a 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -27,21 +27,98 @@ These are all enabled by default, but you can explicitely opt out from them. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `base` | `array` *(comma-separated)* **[header, activity, community, repositories, metadata]** *{"header", "activity", "community", "repositories", "metadata"}* | Metrics base content | -| `repositories` | `number` **[100]** *{0 ≤ đ‘Ĩ}* | Number of repositories to use | -| `repositories_batch` | `number` **[100]** *{1 ≤ đ‘Ĩ ≤ 100}* | Number of repositories to load at once by queries | -| `repositories_forks` | `boolean` **[no]** | Include forks in metrics | -| `repositories_affiliations` | `array` *(comma-separated)* **[owner]** *{"owner", "collaborator", "organization_member"}* | Repositories affiliations | -| `repositories_skipped` ⏭ī¸ | `array` *(comma-separated)* **[]** | Default repositories to skip | -| `users_ignored` ⏭ī¸ ✨ | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Default users to ignore | -| `commits_authoring` ⏭ī¸ | `array` *(comma-seperated)* **[*→ User login*]** | List of surnames or email addresses you use when authoring commits | - - -Legend for option icons: -* ⏭ī¸ Value be inherited by its related plugin-level option -* ✨ Currently in beta-testing on `master`/`main` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
baseMetrics base content
type: array +(comma-separated) +
+default: header, activity, community, repositories, metadata
+allowed values:
  • header
  • activity
  • community
  • repositories
  • metadata
repositoriesNumber of repositories to use
type: number +
+(0 ≤ +đ‘Ĩ) +default: 100
repositories_batchNumber of repositories to load at once by queries
type: number +
+(1 ≤ +đ‘Ĩ +≤ 100) +default: 100
repositories_forksInclude forks in metrics
type: boolean +
+default: no
repositories_affiliationsRepositories affiliations
type: array +(comma-separated) +
+default: owner
+allowed values:
  • owner
  • collaborator
  • organization_member
repositories_skippedDefault repositories to skip
⏭ī¸ Global option
+type: array +(comma-separated) +
users_ignoredDefault users to ignore
⏭ī¸ Global option
+✨ On master/main
+type: array +(comma-separated) +
+default: github-actions[bot], dependabot[bot], dependabot-preview[bot]
commits_authoringList of surnames or email addresses you use when authoring commits
⏭ī¸ Global option
+type: array +(comma-seperated) +
+default: → User login
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/code/README.md b/source/plugins/code/README.md index eca15b33..ad91e499 100644 --- a/source/plugins/code/README.md +++ b/source/plugins/code/README.md @@ -14,18 +14,70 @@ Display a random code snippet from your recent activity history. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_code` | `boolean` **[no]** | Display a random code snippet from recent activity | -| `plugin_code_lines` | `number` **[12]** | Maximum number of line that a code snippet can contain | -| `plugin_code_load` | `number` **[100]** *{100 ≤ đ‘Ĩ ≤ 1000}* | Number of events to load | -| `plugin_code_visibility` | `string` **[public]** *{"public", "all"}* | Set events visibility | -| `plugin_code_skipped` ⏊ | `array` *(comma-separated)* **[]** | Repositories to skip | -| `plugin_code_languages` | `array` *(comma-separated)* **[]** | Restrict code snippet languages | - - -Legend for option icons: -* ⏊ Value inherits from its related global-level option + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_codeDisplay a random code snippet from recent activity
type: boolean +
+default: no
plugin_code_linesMaximum number of line that a code snippet can contain
type: number +
+default: 12
plugin_code_loadNumber of events to load
type: number +
+(100 ≤ +đ‘Ĩ +≤ 1000) +default: 100
plugin_code_visibilitySet events visibility
type: string +
+default: public
+allowed values:
  • public
  • all
plugin_code_skippedRepositories to skip
⏊ Inherits repositories_skipped
+type: array +(comma-separated) +
plugin_code_languagesRestrict code snippet languages
type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 0cb978ce..abf80018 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -37,25 +37,83 @@ Matching is performed in keys order. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_contributors` | `boolean` **[no]** | Display repository contributors | -| `plugin_contributors_base` | `string` **[]** | Base reference | -| `plugin_contributors_head` | `string` **[master]** | Head reference | -| `plugin_contributors_ignored` ⏊ | `array` *(comma-separated)* **[github-actions[bot], dependabot[bot], dependabot-preview[bot]]** | Contributors to ignore | -| `plugin_contributors_contributions` | `boolean` **[no]** | Display contributions | -| `plugin_contributors_sections` | `array` *(comma-separated)* **[contributors]** *{"contributors", "categories"}* | Sections to display | -| `plugin_contributors_categories` 🧰 | `json` **[{ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_contributorsDisplay repository contributors
type: boolean +
+default: no
plugin_contributors_baseBase reference
type: string +
plugin_contributors_headHead reference
type: string +
+default: master
plugin_contributors_ignoredContributors to ignore
⏊ Inherits users_ignored
+type: array +(comma-separated) +
+default: github-actions[bot], dependabot[bot], dependabot-preview[bot]
plugin_contributors_contributionsDisplay contributions
type: boolean +
+default: no
plugin_contributors_sectionsSections to display
type: array +(comma-separated) +
+default: contributors
+allowed values:
  • contributors
  • categories
plugin_contributors_categoriesContributions categories
🌐 Web instances must configure settings.json
+type: json +
+default: { "📚 Documentation": ["README.md", "docs/**"], "đŸ’ģ Code": ["source/**", "src/**"], "#ī¸âƒŖ Others": ["*"] } -]** | Contributions categories | - - -Legend for option icons: -* ⏊ Value inherits from its related global-level option -* 🧰 Must be enabled in `settings.json` (for web instances) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/core/README.md b/source/plugins/core/README.md index 090aa78f..14ce6429 100644 --- a/source/plugins/core/README.md +++ b/source/plugins/core/README.md @@ -5,55 +5,397 @@ Metrics also have general options that impact global metrics rendering. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `token` ✔ī¸ 🔐 | `token` | GitHub Personal Token | -| `user` | `string` **[]** | GitHub username | -| `repo` | `string` **[]** | GitHub repository | -| `committer_token` 🔐 | `token` **[${{ github.token }}]** | GitHub Token used to commit metrics | -| `committer_branch` | `string` **[]** | Branch used to commit rendered metrics | -| `committer_message` | `string` **[Update ${filename} - [Skip GitHub Action]]** | Commit message | -| `committer_gist` | `string` **[]** | Gist used to store metrics | -| `filename` | `string` **[github-metrics.*]** | Rendered metrics output path | -| `markdown` | `string` **[TEMPLATE.md]** | Rendered markdown output path | -| `markdown_cache` | `string` **[.cache]** | Rendered markdown file cache | -| `output_action` | `string` **[commit]** *{"none", "commit", "pull-request", "pull-request-merge", "pull-request-squash", "pull-request-rebase", "gist"}* | Output action | -| `output_condition` | `string` **[always]** *{"always", "data-changed"}* | Output condition | -| `optimize` | `array` *(comma-separated)* **[css, xml]** *{"css", "xml", "svg"}* | SVG optimization | -| `setup_community_templates` 🧰 | `array` *(comma-separated)* **[]** | Additional community templates to setup | -| `template` | `string` **[classic]** | Template to use | -| `query` | `json` **[{}]** | Additional query parameters | -| `extras_css` 🧰 | `string` **[]** | Extra CSS | -| `config_timezone` ⏭ī¸ | `string` **[]** | Timezone used | -| `config_order` ⏭ī¸ | `array` *(comma-separated)* **[]** | Configure content order | -| `config_twemoji` ⏭ī¸ | `boolean` **[no]** | Use twemojis instead of emojis | -| `config_gemoji` ⏭ī¸ | `boolean` **[yes]** | Use GitHub custom emojis | -| `config_display` ⏭ī¸ | `string` **[regular]** *{"regular", "large", "columns"}* | Render display width | -| `config_animations` ⏭ī¸ | `boolean` **[yes]** | SVG CSS animations | -| `config_base64` ⏭ī¸ | `boolean` **[yes]** | Encode images links into base64 data | -| `config_padding` | `string` **[0, 8 + 11%]** | Image padding | -| `config_output` | `string` **[auto]** *{"auto", "svg", "png", "jpeg", "json", "markdown", "markdown-pdf", "insights"}* | Output image format | -| `retries` | `number` **[3]** *{1 ≤ đ‘Ĩ ≤ 10}* | Number of retries | -| `retries_delay` | `number` **[300]** *{0 ≤ đ‘Ĩ ≤ 3600}* | Time to wait (in seconds) before each retry | -| `retries_output_action` | `number` **[5]** *{1 ≤ đ‘Ĩ ≤ 10}* | Number of retries (output action) | -| `retries_delay_output_action` | `number` **[120]** *{0 ≤ đ‘Ĩ ≤ 3600}* | Time to wait (in seconds) before each retry (output action) | -| `delay` | `number` **[0]** *{0 ≤ đ‘Ĩ ≤ 3600}* | Use this to avoid triggering abuse mechanics on large workflows | -| `use_prebuilt_image` | `boolean` **[yes]** | Use pre-built image from GitHub registry | -| `plugins_errors_fatal` 🔧 | `boolean` **[no]** | Die on plugins errors | -| `debug` 🔧 | `boolean` **[no]** | Debug logs | -| `verify` 🔧 | `boolean` **[no]** | Verify SVG | -| `debug_flags` 🔧 | `array` *(space-separated)* **[]** *{"--cakeday", "--hireable", "--halloween", "--error"}* | Debug flags | -| `dryrun` 🔧 | `boolean` **[no]** | Enable dry-run | -| `experimental_features` 🔧 | `array` *(space-separated)* **[]** *{"--optimize-svg"}* | Experimental features | -| `use_mocked_data` 🔧 | `boolean` **[no]** | Use mocked data instead of live APIs | - - -Legend for option icons: -* ✔ī¸ Value must be provided -* 🔐 Value should be stored in repository secrets -* ⏭ī¸ Value be inherited by its related plugin-level option -* 🔧 For development purposes, use with caution -* 🧰 Must be enabled in `settings.json` (for web instances) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
tokenGitHub Personal Token
✔ī¸ Required
+🔐 Token
+type: token +
userGitHub username
type: string +
repoGitHub repository
type: string +
committer_tokenGitHub Token used to commit metrics
🔐 Token
+type: token +
+default: ${{ github.token }}
committer_branchBranch used to commit rendered metrics
type: string +
committer_messageCommit message
type: string +
+default: Update ${filename} - [Skip GitHub Action]
committer_gistGist used to store metrics
type: string +
filenameRendered metrics output path
type: string +
+default: github-metrics.*
markdownRendered markdown output path
type: string +
+default: TEMPLATE.md
markdown_cacheRendered markdown file cache
type: string +
+default: .cache
output_actionOutput action
type: string +
+default: commit
+allowed values:
  • none
  • commit
  • pull-request
  • pull-request-merge
  • pull-request-squash
  • pull-request-rebase
  • gist
output_conditionOutput condition
type: string +
+default: always
+allowed values:
  • always
  • data-changed
optimizeSVG optimization
type: array +(comma-separated) +
+default: css, xml
+allowed values:
  • css
  • xml
  • svg
setup_community_templatesAdditional community templates to setup
🌐 Web instances must configure settings.json
+type: array +(comma-separated) +
templateTemplate to use
type: string +
+default: classic
queryAdditional query parameters
type: json +
+default: {}
extras_cssExtra CSS
🌐 Web instances must configure settings.json
+type: string +
config_timezoneTimezone used
⏭ī¸ Global option
+type: string +
config_orderConfigure content order
⏭ī¸ Global option
+type: array +(comma-separated) +
config_twemojiUse twemojis instead of emojis
⏭ī¸ Global option
+type: boolean +
+default: no
config_gemojiUse GitHub custom emojis
⏭ī¸ Global option
+type: boolean +
+default: yes
config_displayRender display width
⏭ī¸ Global option
+type: string +
+default: regular
+allowed values:
  • regular
  • large
  • columns
config_animationsSVG CSS animations
⏭ī¸ Global option
+type: boolean +
+default: yes
config_base64Encode images links into base64 data
⏭ī¸ Global option
+type: boolean +
+default: yes
config_paddingImage padding
type: string +
+default: 0, 8 + 11%
config_outputOutput image format
type: string +
+default: auto
+allowed values:
  • auto
  • svg
  • png
  • jpeg
  • json
  • markdown
  • markdown-pdf
  • insights
retriesNumber of retries
type: number +
+(1 ≤ +đ‘Ĩ +≤ 10) +default: 3
retries_delayTime to wait (in seconds) before each retry
type: number +
+(0 ≤ +đ‘Ĩ +≤ 3600) +default: 300
retries_output_actionNumber of retries (output action)
type: number +
+(1 ≤ +đ‘Ĩ +≤ 10) +default: 5
retries_delay_output_actionTime to wait (in seconds) before each retry (output action)
type: number +
+(0 ≤ +đ‘Ĩ +≤ 3600) +default: 120
delayUse this to avoid triggering abuse mechanics on large workflows
type: number +
+(0 ≤ +đ‘Ĩ +≤ 3600) +default: 0
use_prebuilt_imageUse pre-built image from GitHub registry
type: boolean +
+default: yes
plugins_errors_fatalDie on plugins errors
🔧 For development +type: boolean +
+default: no
debugDebug logs
🔧 For development +type: boolean +
+default: no
verifyVerify SVG
🔧 For development +type: boolean +
+default: no
debug_flagsDebug flags
🔧 For development +type: array +(space-separated) +
+allowed values:
  • --cakeday
  • --hireable
  • --halloween
  • --error
dryrunEnable dry-run
🔧 For development +type: boolean +
+default: no
experimental_featuresExperimental features
🔧 For development +type: array +(space-separated) +
+allowed values:
  • --optimize-svg
use_mocked_dataUse mocked data instead of live APIs
🔧 For development +type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/discussions/README.md b/source/plugins/discussions/README.md index c1d3c558..96f4b1e6 100644 --- a/source/plugins/discussions/README.md +++ b/source/plugins/discussions/README.md @@ -12,15 +12,40 @@ The *discussions* plugin displays your GitHub discussions metrics. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_discussions` | `boolean` **[no]** | GitHub discussions metrics | -| `plugin_discussions_categories` ✨ | `boolean` **[yes]** | Display discussion categories | -| `plugin_discussions_categories_limit` ✨ | `number` **[0]** | Number of discussion categories to display | - - -Legend for option icons: -* ✨ Currently in beta-testing on `master`/`main` + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_discussionsGitHub discussions metrics
type: boolean +
+default: no
plugin_discussions_categoriesDisplay discussion categories
✨ On master/main
+type: boolean +
+default: yes
plugin_discussions_categories_limitNumber of discussion categories to display
✨ On master/main
+type: number +
+default: 0
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/followup/README.md b/source/plugins/followup/README.md index 26169c5d..20d747ba 100644 --- a/source/plugins/followup/README.md +++ b/source/plugins/followup/README.md @@ -20,15 +20,41 @@ The *followup* plugin displays the ratio of open/closed issues and the ratio of #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_followup` | `boolean` **[no]** | Display follow-up of repositories issues and pull requests | -| `plugin_followup_sections` | `array` *(comma-separated)* **[repositories]** *{"repositories", "user"}* | Sections to display | -| `plugin_followup_indepth` 🧰 | `boolean` **[no]** | Indepth follow-up processing | - - -Legend for option icons: -* 🧰 Must be enabled in `settings.json` (for web instances) + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_followupDisplay follow-up of repositories issues and pull requests
type: boolean +
+default: no
plugin_followup_sectionsSections to display
type: array +(comma-separated) +
+default: repositories
+allowed values:
  • repositories
  • user
plugin_followup_indepthIndepth follow-up processing
🌐 Web instances must configure settings.json
+type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/gists/README.md b/source/plugins/gists/README.md index 142061af..b950b112 100644 --- a/source/plugins/gists/README.md +++ b/source/plugins/gists/README.md @@ -12,11 +12,20 @@ The *gists* plugin displays your [gists](https://gist.github.com) metrics. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_gists` | `boolean` **[no]** | Display gists metrics | - - + + + + + + + + + + + +
TypeDescription
plugin_gistsDisplay gists metrics
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/habits/README.md b/source/plugins/habits/README.md index 059e9699..c4ce7020 100644 --- a/source/plugins/habits/README.md +++ b/source/plugins/habits/README.md @@ -28,18 +28,72 @@ By default, dates use Greenwich meridian (GMT/UTC). Be sure to set your timezone #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_habits` | `boolean` **[no]** | Display coding habits metrics | -| `plugin_habits_from` | `number` **[200]** *{1 ≤ đ‘Ĩ ≤ 1000}* | Number of events to use | -| `plugin_habits_days` | `number` **[14]** *{1 ≤ đ‘Ĩ ≤ 30}* | Maximum event age | -| `plugin_habits_facts` | `boolean` **[yes]** | Display coding habits collected facts based on recent activity | -| `plugin_habits_charts` 🧰 | `boolean` **[no]** | Display coding habits charts based on recent activity | -| `plugin_habits_trim` | `boolean` **[no]** | Trim unused hours on daily chart | - - -Legend for option icons: -* 🧰 Must be enabled in `settings.json` (for web instances) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_habitsDisplay coding habits metrics
type: boolean +
+default: no
plugin_habits_fromNumber of events to use
type: number +
+(1 ≤ +đ‘Ĩ +≤ 1000) +default: 200
plugin_habits_daysMaximum event age
type: number +
+(1 ≤ +đ‘Ĩ +≤ 30) +default: 14
plugin_habits_factsDisplay coding habits collected facts based on recent activity
type: boolean +
+default: yes
plugin_habits_chartsDisplay coding habits charts based on recent activity
🌐 Web instances must configure settings.json
+type: boolean +
+default: no
plugin_habits_trimTrim unused hours on daily chart
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/introduction/README.md b/source/plugins/introduction/README.md index 0c94f7f1..ef30df1f 100644 --- a/source/plugins/introduction/README.md +++ b/source/plugins/introduction/README.md @@ -18,12 +18,29 @@ It is mostly intended for metrics used outside of GitHub, since these informatio #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_introduction` | `boolean` **[no]** | Display account or repository introduction | -| `plugin_introduction_title` | `boolean` **[yes]** | Display introduction section title | - - + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_introductionDisplay account or repository introduction
type: boolean +
+default: no
plugin_introduction_titleDisplay introduction section title
type: boolean +
+default: yes
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/isocalendar/README.md b/source/plugins/isocalendar/README.md index 3eff2a87..5202a3df 100644 --- a/source/plugins/isocalendar/README.md +++ b/source/plugins/isocalendar/README.md @@ -1,12 +1,78 @@ + + + + + + + + + + + + + + + + +

📅 Isometric commit calendar

This plugin displays an isometric view of your commit calendar along with a few additional statistics like current streak and average number of commit per day.
Supported features
→ Full specification		📗 Classic template 📙 Terminal template
👤 Users
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
Full year calendar
+
Half year calendar
+ +
## ➡ī¸ Available options + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_isocalendarEnable isocalendar plugin
type: boolean +
+default: no
plugin_isocalendar_durationTime window
type: string +
+default: half-year
+allowed values:
  • half-year
  • full-year
## ℹī¸ Examples workflows +```yaml +name: Half-year calendar +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.isocalendar.svg + token: ${{ secrets.METRICS_TOKEN }} + base: '' + plugin_isocalendar: 'yes' + +``` +```yaml +name: Full-year calendar +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.isocalendar.fullyear.svg + token: ${{ secrets.METRICS_TOKEN }} + base: '' + plugin_isocalendar: 'yes' + plugin_isocalendar_duration: full-year + +``` diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md index 0a7da2f6..bfcc5fc8 100644 --- a/source/plugins/languages/README.md +++ b/source/plugins/languages/README.md @@ -1,9 +1,200 @@ + + + + + + + + + + + + + + + + +

🈷ī¸ Most used languages

This plugin can display which languages you use across all repositories you contributed to.
Supported features
→ Full specification		📗 Classic template 📘 Repository template 📙 Terminal template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
🔑 (scopeless) read:org (optional) read:user (optional) repo (optional)
+
Indepth analysis (clone and analyze repositories)
+
Recently used (analyze recent activity events)
+
Default algorithm
+
Default algorithm (with details)
+ +
## ➡ī¸ Available options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_languagesEnable languages plugin
type: boolean +
+default: no
plugin_languages_ignoredIgnored languages
type: array +(comma-separated) +
plugin_languages_skippedSkipped repositories
⏊ Inherits repositories_skipped
+type: array +(comma-separated) +
plugin_languages_limitDisplay limit
type: number +
+(0 ≤ +đ‘Ĩ +≤ 8) +default: 8
plugin_languages_thresholdDisplay threshold (percentage)
type: string +
+default: 0%
plugin_languages_colorsCustom languages colors
type: array +(comma-separated) +
+default: github
plugin_languages_aliasesCustom languages names
type: string +
plugin_languages_sectionsDisplayed sections
🌐 Web instances must configure settings.json
+type: array +(comma-separated) +
+default: most-used
+allowed values:
  • most-used
  • recently-used
plugin_languages_detailsAdditional details
🌐 Web instances must configure settings.json
+type: array +(comma-separated) +
+allowed values:
  • bytes-size
  • percentage
  • lines
plugin_languages_indepthIndepth mode (⚠ī¸ read documentation first)
🌐 Web instances must configure settings.json
+type: boolean +
+default: false
plugin_languages_analysis_timeoutIndepth mode - Analysis timeout
🌐 Web instances must configure settings.json
+type: number +
+(1 ≤ +đ‘Ĩ +≤ 30) +default: 15
plugin_languages_categoriesIndepth mode - Displayed categories (most-used section)
🌐 Web instances must configure settings.json
+type: array +(comma-separated) +
+default: markup, programming
+allowed values:
  • data
  • markup
  • programming
  • prose
plugin_languages_recent_categoriesIndepth mode - Displayed categories (recently-used section)
🌐 Web instances must configure settings.json
+type: array +(comma-separated) +
+default: markup, programming
+allowed values:
  • data
  • markup
  • programming
  • prose
plugin_languages_recent_loadEvents to load (recently-used section)
🌐 Web instances must configure settings.json
+type: number +
+(100 ≤ +đ‘Ĩ +≤ 1000) +default: 300
plugin_languages_recent_daysEvents maximum age (day, recently-used section)
🌐 Web instances must configure settings.json
+type: number +
+(0 ≤ +đ‘Ĩ +≤ 365) +default: 14
## 🔎 `indepth` mode @@ -136,4 +327,66 @@ To mitigate this, it is possible to use `plugin_languages_aliases` option and pr ## ℹī¸ Examples workflows +```yaml +name: Most used +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.languages.svg + token: ${{ secrets.METRICS_TOKEN }} + base: '' + plugin_languages: 'yes' + plugin_languages_ignored: >- + html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell, + gnuplot + plugin_languages_limit: 4 + +``` +```yaml +name: Most used (with details) +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.languages.details.svg + token: ${{ secrets.METRICS_TOKEN }} + base: '' + plugin_languages: 'yes' + plugin_languages_ignored: >- + html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell, + gnuplot + plugin_languages_details: bytes-size, percentage + plugin_languages_limit: 4 + +``` +```yaml +name: Recently used +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.languages.recent.svg + token: ${{ secrets.METRICS_TOKEN }} + base: '' + plugin_languages: 'yes' + plugin_languages_ignored: >- + html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell, + gnuplot + plugin_languages_sections: recently-used + plugin_languages_details: bytes-size, percentage + plugin_languages_limit: 4 + +``` +```yaml +name: Indepth analysis +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.languages.indepth.svg + token: ${{ secrets.METRICS_TOKEN }} + base: '' + plugin_languages: 'yes' + plugin_languages_ignored: >- + html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell, + gnuplot + plugin_languages_indepth: 'yes' + plugin_languages_details: lines, bytes-size + plugin_languages_limit: 4 + plugin_languages_analysis_timeout: 15 + +``` diff --git a/source/plugins/licenses/README.md b/source/plugins/licenses/README.md index 2902439d..efac1a6e 100644 --- a/source/plugins/licenses/README.md +++ b/source/plugins/licenses/README.md @@ -27,16 +27,47 @@ Dependencies will be analyzed with [github/licensed](https://github.com/github/l #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_licenses` 🧰 | `boolean` **[no]** | Display licenses informations | -| `plugin_licenses_setup` | `string` **[]** | Command to setup target repository | -| `plugin_licenses_ratio` | `boolean` **[no]** | Display used licenses ratio | -| `plugin_licenses_legal` | `boolean` **[yes]** | Display legal informations about used licenses | - - -Legend for option icons: -* 🧰 Must be enabled in `settings.json` (for web instances) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_licensesDisplay licenses informations
🌐 Web instances must configure settings.json
+type: boolean +
+default: no
plugin_licenses_setupCommand to setup target repository
type: string +
plugin_licenses_ratioDisplay used licenses ratio
type: boolean +
+default: no
plugin_licenses_legalDisplay legal informations about used licenses
type: boolean +
+default: yes
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/lines/README.md b/source/plugins/lines/README.md index cc185df0..05dcd86f 100644 --- a/source/plugins/lines/README.md +++ b/source/plugins/lines/README.md @@ -12,14 +12,30 @@ The *lines* of code plugin displays the number of lines of code you have added a #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_lines` | `boolean` **[no]** | Display lines of code metrics | -| `plugin_lines_skipped` ⏊ | `array` *(comma-separated)* **[]** | Repositories to skip | - - -Legend for option icons: -* ⏊ Value inherits from its related global-level option + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_linesDisplay lines of code metrics
type: boolean +
+default: no
plugin_lines_skippedRepositories to skip
⏊ Inherits repositories_skipped
+type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/music/README.md b/source/plugins/music/README.md index 6734aebf..1a54ac0d 100644 --- a/source/plugins/music/README.md +++ b/source/plugins/music/README.md @@ -208,22 +208,105 @@ Click on the Name of any matching request. In the “Headers” tab, scroll to t #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_music` | `boolean` **[no]** | Display your music tracks | -| `plugin_music_provider` | `string` **[]** *{"apple", "spotify", "lastfm", "youtube"}* | Music provider | -| `plugin_music_token` 🔐 | `token` **[]** | Music provider personal token | -| `plugin_music_mode` | `string` **[]** *{"playlist", "recent", "top"}* | Plugin mode | -| `plugin_music_playlist` | `string` **[]** | Embed playlist url | -| `plugin_music_limit` | `number` **[4]** *{1 ≤ đ‘Ĩ ≤ 100}* | Maximum number of tracks to display | -| `plugin_music_played_at` | `boolean` **[no]** | Display when the track was played | -| `plugin_music_time_range` | `string` **[short]** *{"short", "medium", "long"}* | Time period for top mode | -| `plugin_music_top_type` | `string` **[tracks]** *{"tracks", "artists"}* | Whether to show tracks or artists in top mode | -| `plugin_music_user` | `string` **[*→ User login*]** | Music provider username | - - -Legend for option icons: -* 🔐 Value should be stored in repository secrets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_musicDisplay your music tracks
type: boolean +
+default: no
plugin_music_providerMusic provider
type: string +
+allowed values:
  • apple
  • spotify
  • lastfm
  • youtube
plugin_music_tokenMusic provider personal token
🔐 Token
+type: token +
plugin_music_modePlugin mode
type: string +
+allowed values:
  • playlist
  • recent
  • top
plugin_music_playlistEmbed playlist url
type: string +
plugin_music_limitMaximum number of tracks to display
type: number +
+(1 ≤ +đ‘Ĩ +≤ 100) +default: 4
plugin_music_played_atDisplay when the track was played
type: boolean +
+default: no
plugin_music_time_rangeTime period for top mode
type: string +
+default: short
+allowed values:
  • short
  • medium
  • long
plugin_music_top_typeWhether to show tracks or artists in top mode
type: string +
+default: tracks
+allowed values:
  • tracks
  • artists
plugin_music_userMusic provider username
type: string +
+default: → User login
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/nightscout/README.md b/source/plugins/nightscout/README.md index 75b18197..be672c86 100644 --- a/source/plugins/nightscout/README.md +++ b/source/plugins/nightscout/README.md @@ -19,17 +19,84 @@ The [nightscout website](http://www.nightscout.info/) details how to self-host a #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_nightscout` | `boolean` **[no]** | Displays Blood Glucose | -| `plugin_nightscout_url` | `string` **[https://example.herokuapp.com]** | Your Nightscout site URL | -| `plugin_nightscout_datapoints` | `number` **[12]** *{0 ≤ đ‘Ĩ}* | How many datapoints to show on the graph. 0 and 1 disable the graph. | -| `plugin_nightscout_lowalert` | `number` **[80]** *{0 ≤ đ‘Ĩ}* | When the blood sugar is considered low | -| `plugin_nightscout_highalert` | `number` **[180]** *{0 ≤ đ‘Ĩ}* | When the blood sugar is considered high | -| `plugin_nightscout_urgentlowalert` | `number` **[50]** *{0 ≤ đ‘Ĩ}* | When the blood sugar is considered urgently low | -| `plugin_nightscout_urgenthighalert` | `number` **[250]** *{0 ≤ đ‘Ĩ}* | When the blood sugar is considered urgently high | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_nightscoutDisplays Blood Glucose
type: boolean +
+default: no
plugin_nightscout_urlYour Nightscout site URL
type: string +
+default: https://example.herokuapp.com
plugin_nightscout_datapointsHow many datapoints to show on the graph. 0 and 1 disable the graph.
type: number +
+(0 ≤ +đ‘Ĩ) +default: 12
plugin_nightscout_lowalertWhen the blood sugar is considered low
type: number +
+(0 ≤ +đ‘Ĩ) +default: 80
plugin_nightscout_highalertWhen the blood sugar is considered high
type: number +
+(0 ≤ +đ‘Ĩ) +default: 180
plugin_nightscout_urgentlowalertWhen the blood sugar is considered urgently low
type: number +
+(0 ≤ +đ‘Ĩ) +default: 50
plugin_nightscout_urgenthighalertWhen the blood sugar is considered urgently high
type: number +
+(0 ≤ +đ‘Ĩ) +default: 250
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/notable/README.md b/source/plugins/notable/README.md index ce05970d..527647a6 100644 --- a/source/plugins/notable/README.md +++ b/source/plugins/notable/README.md @@ -24,17 +24,57 @@ The `plugin_notable_indepth` option lets you get additional metrics about your c #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_notable` | `boolean` **[no]** | Display notable contributions in organizations | -| `plugin_notable_filter` | `string` **[]** | Query filter | -| `plugin_notable_from` | `string` **[organization]** *{"all", "organization", "user"}* | Filter by repository host account type | -| `plugin_notable_repositories` | `boolean` **[no]** | Also display repository name | -| `plugin_notable_indepth` 🧰 | `boolean` **[no]** | Indepth notable contributions processing | - - -Legend for option icons: -* 🧰 Must be enabled in `settings.json` (for web instances) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_notableDisplay notable contributions in organizations
type: boolean +
+default: no
plugin_notable_filterQuery filter
type: string +
plugin_notable_fromFilter by repository host account type
type: string +
+default: organization
+allowed values:
  • all
  • organization
  • user
plugin_notable_repositoriesAlso display repository name
type: boolean +
+default: no
plugin_notable_indepthIndepth notable contributions processing
🌐 Web instances must configure settings.json
+type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/pagespeed/README.md b/source/plugins/pagespeed/README.md index 890f32a0..ac7b303c 100644 --- a/source/plugins/pagespeed/README.md +++ b/source/plugins/pagespeed/README.md @@ -29,17 +29,56 @@ Expect 10 to 30 seconds to generate the results. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_pagespeed` | `boolean` **[no]** | Display a website Google PageSpeed metrics | -| `plugin_pagespeed_url` | `string` **[*→ User attached website*]** | Audited website | -| `plugin_pagespeed_detailed` | `boolean` **[no]** | Detailed audit result | -| `plugin_pagespeed_screenshot` | `boolean` **[no]** | Display a screenshot of your website | -| `plugin_pagespeed_token` 🔐 | `token` **[]** | PageSpeed token | - - -Legend for option icons: -* 🔐 Value should be stored in repository secrets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_pagespeedDisplay a website Google PageSpeed metrics
type: boolean +
+default: no
plugin_pagespeed_urlAudited website
type: string +
+default: → User attached website
plugin_pagespeed_detailedDetailed audit result
type: boolean +
+default: no
plugin_pagespeed_screenshotDisplay a screenshot of your website
type: boolean +
+default: no
plugin_pagespeed_tokenPageSpeed token
🔐 Token
+type: token +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/people/README.md b/source/plugins/people/README.md index fe25a5b4..32f2f7a5 100644 --- a/source/plugins/people/README.md +++ b/source/plugins/people/README.md @@ -36,18 +36,90 @@ Sections will be ordered the same as specified in `plugin_people_types`. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_people` | `boolean` **[no]** | Display GitHub users from various affiliations | -| `plugin_people_limit` | `number` **[24]** *{0 ≤ đ‘Ĩ}* | Maximum number of user to display | -| `plugin_people_size` | `number` **[28]** *{8 ≤ đ‘Ĩ ≤ 64}* | Size of displayed GitHub users' avatars | -| `plugin_people_types` | `array` *(comma-separated)* **[followers, following]** *{"followers", "following", "followed", "sponsoring", "members", "sponsored", "sponsors", "contributors", "stargazers", "watchers", "thanks"}* | Affiliations to display | -| `plugin_people_thanks` | `array` *(comma-separated)* **[]** | GitHub users to personally thanks | -| `plugin_people_sponsors_custom` | `array` *(comma-separated)* **[]** | Custom GitHub sponsors | -| `plugin_people_identicons` | `boolean` **[no]** | Use identicons instead of avatars | -| `plugin_people_shuffle` | `boolean` **[no]** | Shuffle users | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_peopleDisplay GitHub users from various affiliations
type: boolean +
+default: no
plugin_people_limitMaximum number of user to display
type: number +
+(0 ≤ +đ‘Ĩ) +default: 24
plugin_people_sizeSize of displayed GitHub users' avatars
type: number +
+(8 ≤ +đ‘Ĩ +≤ 64) +default: 28
plugin_people_typesAffiliations to display
type: array +(comma-separated) +
+default: followers, following
+allowed values:
  • followers
  • following
  • followed
  • sponsoring
  • members
  • sponsored
  • sponsors
  • contributors
  • stargazers
  • watchers
  • thanks
plugin_people_thanksGitHub users to personally thanks
type: array +(comma-separated) +
plugin_people_sponsors_customCustom GitHub sponsors
type: array +(comma-separated) +
plugin_people_identiconsUse identicons instead of avatars
type: boolean +
+default: no
plugin_people_shuffleShuffle users
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/poopmap/README.md b/source/plugins/poopmap/README.md index 96142ed1..52098e65 100644 --- a/source/plugins/poopmap/README.md +++ b/source/plugins/poopmap/README.md @@ -42,15 +42,39 @@ You now have your PoopMap token! This token will not expire and it can only acce #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_poopmap` | `boolean` **[no]** | Display PoopMap stats | -| `plugin_poopmap_token` 🔐 | `token` **[]** | PoopMap API token | -| `plugin_poopmap_days` | `number` **[7]** *{"7", "30", "180", "365"}* | PoopMap time range | - - -Legend for option icons: -* 🔐 Value should be stored in repository secrets + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_poopmapDisplay PoopMap stats
type: boolean +
+default: no
plugin_poopmap_tokenPoopMap API token
🔐 Token
+type: token +
plugin_poopmap_daysPoopMap time range
type: number +
+default: 7
+allowed values:
  • 7
  • 30
  • 180
  • 365
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/posts/README.md b/source/plugins/posts/README.md index d508ca18..140b0414 100644 --- a/source/plugins/posts/README.md +++ b/source/plugins/posts/README.md @@ -17,16 +17,68 @@ The recent *posts* plugin displays recent articles you wrote on an external sour #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_posts` | `boolean` **[no]** | Display recent posts | -| `plugin_posts_source` | `string` **[]** *{"dev.to", "hashnode"}* | Posts external source | -| `plugin_posts_descriptions` | `boolean` **[no]** | Display posts descriptions | -| `plugin_posts_covers` | `boolean` **[no]** | Display posts cover images | -| `plugin_posts_limit` | `number` **[4]** *{1 ≤ đ‘Ĩ ≤ 30}* | Maximum number of posts to display | -| `plugin_posts_user` | `string` **[*→ User login*]** | Posts external source username | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_postsDisplay recent posts
type: boolean +
+default: no
plugin_posts_sourcePosts external source
type: string +
+allowed values:
  • dev.to
  • hashnode
plugin_posts_descriptionsDisplay posts descriptions
type: boolean +
+default: no
plugin_posts_coversDisplay posts cover images
type: boolean +
+default: no
plugin_posts_limitMaximum number of posts to display
type: number +
+(1 ≤ +đ‘Ĩ +≤ 30) +default: 4
plugin_posts_userPosts external source username
type: string +
+default: → User login
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/projects/README.md b/source/plugins/projects/README.md index 0d9b5b00..797eb261 100644 --- a/source/plugins/projects/README.md +++ b/source/plugins/projects/README.md @@ -43,14 +43,50 @@ To do so, open your repository project and retrieve the last URL endpoint, in th #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_projects` | `boolean` **[no]** | Display active projects | -| `plugin_projects_limit` | `number` **[4]** *{0 ≤ đ‘Ĩ ≤ 100}* | Maximum number of projects to display | -| `plugin_projects_repositories` | `array` *(comma-separated)* **[]** | List of repository project identifiers to disaplay | -| `plugin_projects_descriptions` | `boolean` **[no]** | Display projects descriptions | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_projectsDisplay active projects
type: boolean +
+default: no
plugin_projects_limitMaximum number of projects to display
type: number +
+(0 ≤ +đ‘Ĩ +≤ 100) +default: 4
plugin_projects_repositoriesList of repository project identifiers to disaplay
type: array +(comma-separated) +
plugin_projects_descriptionsDisplay projects descriptions
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/reactions/README.md b/source/plugins/reactions/README.md index c8e741ac..db8f9b81 100644 --- a/source/plugins/reactions/README.md +++ b/source/plugins/reactions/README.md @@ -12,21 +12,109 @@ The *reactions* plugin displays overall reactions on your recent issues and issu #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_reactions` | `boolean` **[no]** | Display average issue comments reactions | -| `plugin_reactions_limit` | `number` **[200]** *{0 ≤ đ‘Ĩ ≤ 1000}* | Maximum number of issue comments to parse | -| `plugin_reactions_limit_issues` | `number` **[100]** *{0 ≤ đ‘Ĩ ≤ 1000}* | Maximum number of issues and pull requests opened to parse | -| `plugin_reactions_limit_discussions` | `number` **[100]** *{0 ≤ đ‘Ĩ ≤ 1000}* | Maximum number of discussions opened to parse | -| `plugin_reactions_limit_discussions_comments` | `number` **[100]** *{0 ≤ đ‘Ĩ ≤ 1000}* | Maximum number of discussions comments opened to parse | -| `plugin_reactions_days` | `number` **[0]** *{0 ≤ đ‘Ĩ}* | Maximum comments age | -| `plugin_reactions_display` | `string` **[absolute]** *{"absolute", "relative"}* | Display mode | -| `plugin_reactions_details` | `array` *(comma-separated)* **[]** *{"count", "percentage"}* | Additional details | -| `plugin_reactions_ignored` ⏊ | `array` *(comma-separated)* **[]** | Users to ignore | - - -Legend for option icons: -* ⏊ Value inherits from its related global-level option + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_reactionsDisplay average issue comments reactions
type: boolean +
+default: no
plugin_reactions_limitMaximum number of issue comments to parse
type: number +
+(0 ≤ +đ‘Ĩ +≤ 1000) +default: 200
plugin_reactions_limit_issuesMaximum number of issues and pull requests opened to parse
type: number +
+(0 ≤ +đ‘Ĩ +≤ 1000) +default: 100
plugin_reactions_limit_discussionsMaximum number of discussions opened to parse
type: number +
+(0 ≤ +đ‘Ĩ +≤ 1000) +default: 100
plugin_reactions_limit_discussions_commentsMaximum number of discussions comments opened to parse
type: number +
+(0 ≤ +đ‘Ĩ +≤ 1000) +default: 100
plugin_reactions_daysMaximum comments age
type: number +
+(0 ≤ +đ‘Ĩ) +default: 0
plugin_reactions_displayDisplay mode
type: string +
+default: absolute
+allowed values:
  • absolute
  • relative
plugin_reactions_detailsAdditional details
type: array +(comma-separated) +
+allowed values:
  • count
  • percentage
plugin_reactions_ignoredUsers to ignore
⏊ Inherits users_ignored
+type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/repositories/README.md b/source/plugins/repositories/README.md index 02ab5a54..289511ae 100644 --- a/source/plugins/repositories/README.md +++ b/source/plugins/repositories/README.md @@ -16,12 +16,29 @@ Because of limitations of using SVG inside of `` tags, people won't be able #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_repositories` | `boolean` **[no]** | Display chosen featured repositories | -| `plugin_repositories_featured` | `array` *(comma-separated)* **[]** | List of repositories to display | - - + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_repositoriesDisplay chosen featured repositories
type: boolean +
+default: no
plugin_repositories_featuredList of repositories to display
type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/rss/README.md b/source/plugins/rss/README.md index 423267c6..f5602f71 100644 --- a/source/plugins/rss/README.md +++ b/source/plugins/rss/README.md @@ -12,13 +12,40 @@ The *rss* plugin displays items from a specified RSS feed. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_rss` | `boolean` **[no]** | Display RSS feed | -| `plugin_rss_source` | `string` **[]** | RSS feed source | -| `plugin_rss_limit` | `number` **[4]** *{0 ≤ đ‘Ĩ ≤ 30}* | Maximum number of items to display | - - + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_rssDisplay RSS feed
type: boolean +
+default: no
plugin_rss_sourceRSS feed source
type: string +
plugin_rss_limitMaximum number of items to display
type: number +
+(0 ≤ +đ‘Ĩ +≤ 30) +default: 4
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/screenshot/README.md b/source/plugins/screenshot/README.md index bb92607f..8007a310 100644 --- a/source/plugins/screenshot/README.md +++ b/source/plugins/screenshot/README.md @@ -13,15 +13,55 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_screenshot` | `boolean` **[no]** | Display a screenshot of any website | -| `plugin_screenshot_title` | `string` **[Screenshot]** | Screenshot title caption | -| `plugin_screenshot_url` | `string` **[]** | Website to take screenshot | -| `plugin_screenshot_selector` | `string` **[body]** | Selector to take in screenshot | -| `plugin_screenshot_background` | `boolean` **[yes]** | Display or remove default page background | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_screenshotDisplay a screenshot of any website
type: boolean +
+default: no
plugin_screenshot_titleScreenshot title caption
type: string +
+default: Screenshot
plugin_screenshot_urlWebsite to take screenshot
type: string +
plugin_screenshot_selectorSelector to take in screenshot
type: string +
+default: body
plugin_screenshot_backgroundDisplay or remove default page background
type: boolean +
+default: yes
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/skyline/README.md b/source/plugins/skyline/README.md index 1c6d2bc2..ec5ec5f4 100644 --- a/source/plugins/skyline/README.md +++ b/source/plugins/skyline/README.md @@ -16,15 +16,64 @@ This uses puppeteer to generate collect image frames, and use CSS animations to #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_skyline` | `boolean` **[no]** | Display GitHub Skyline 3D calendar | -| `plugin_skyline_year` | `number` **[current-year]** *{2008 ≤ đ‘Ĩ}* | Displayed year | -| `plugin_skyline_frames` | `number` **[60]** *{1 ≤ đ‘Ĩ ≤ 120}* | Number of frames | -| `plugin_skyline_quality` | `number` **[0.5]** *{0.1 ≤ đ‘Ĩ ≤ 1}* | Image quality | -| `plugin_skyline_compatibility` | `boolean` **[no]** | Compatibility mode | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_skylineDisplay GitHub Skyline 3D calendar
type: boolean +
+default: no
plugin_skyline_yearDisplayed year
type: number +
+(2008 ≤ +đ‘Ĩ) +default: current-year
plugin_skyline_framesNumber of frames
type: number +
+(1 ≤ +đ‘Ĩ +≤ 120) +default: 60
plugin_skyline_qualityImage quality
type: number +
+(0.1 ≤ +đ‘Ĩ +≤ 1) +default: 0.5
plugin_skyline_compatibilityCompatibility mode
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/sponsors/README.md b/source/plugins/sponsors/README.md index a7cbb581..4343168a 100644 --- a/source/plugins/sponsors/README.md +++ b/source/plugins/sponsors/README.md @@ -17,12 +17,31 @@ The *sponsors* plugin lets you display your sponsors and introduction text from #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_sponsors` | `boolean` **[no]** | Display GitHub sponsors | -| `plugin_sponsors_sections` | `array` *(comma-separated)* **[goal, about]** *{"goal", "about"}* | Sections to display | - - + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_sponsorsDisplay GitHub sponsors
type: boolean +
+default: no
plugin_sponsors_sectionsSections to display
type: array +(comma-separated) +
+default: goal, about
+allowed values:
  • goal
  • about
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/stackoverflow/README.md b/source/plugins/stackoverflow/README.md index a318ebb7..e2453e6a 100644 --- a/source/plugins/stackoverflow/README.md +++ b/source/plugins/stackoverflow/README.md @@ -23,16 +23,74 @@ Your user id will be in both url and search bar. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_stackoverflow` | `boolean` **[no]** | Stackoverflow metrics | -| `plugin_stackoverflow_user` | `number` **[0]** | Stackoverflow user id | -| `plugin_stackoverflow_sections` | `array` *(comma-separated)* **[answers-top, questions-recent]** *{"answers-top", "answers-recent", "questions-top", "questions-recent"}* | Sections to display | -| `plugin_stackoverflow_limit` | `number` **[2]** *{1 ≤ đ‘Ĩ ≤ 30}* | Maximum number of entries to display per section | -| `plugin_stackoverflow_lines` | `number` **[4]** *{0 ≤ đ‘Ĩ}* | Maximum number of lines to display per question or answer | -| `plugin_stackoverflow_lines_snippet` | `number` **[2]** *{0 ≤ đ‘Ĩ}* | Maximum number of lines to display per code snippet | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_stackoverflowStackoverflow metrics
type: boolean +
+default: no
plugin_stackoverflow_userStackoverflow user id
type: number +
+default: 0
plugin_stackoverflow_sectionsSections to display
type: array +(comma-separated) +
+default: answers-top, questions-recent
+allowed values:
  • answers-top
  • answers-recent
  • questions-top
  • questions-recent
plugin_stackoverflow_limitMaximum number of entries to display per section
type: number +
+(1 ≤ +đ‘Ĩ +≤ 30) +default: 2
plugin_stackoverflow_linesMaximum number of lines to display per question or answer
type: number +
+(0 ≤ +đ‘Ĩ) +default: 4
plugin_stackoverflow_lines_snippetMaximum number of lines to display per code snippet
type: number +
+(0 ≤ +đ‘Ĩ) +default: 2
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/stargazers/README.md b/source/plugins/stargazers/README.md index e83a34cf..feace2e5 100644 --- a/source/plugins/stargazers/README.md +++ b/source/plugins/stargazers/README.md @@ -12,11 +12,20 @@ The *stargazers* plugin displays your stargazers evolution across all of your re #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_stargazers` | `boolean` **[no]** | Display stargazers metrics | - - + + + + + + + + + + + +
TypeDescription
plugin_stargazersDisplay stargazers metrics
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/starlists/README.md b/source/plugins/starlists/README.md index e74950de..94e810e5 100644 --- a/source/plugins/starlists/README.md +++ b/source/plugins/starlists/README.md @@ -12,18 +12,77 @@ The *starlists* plugin displays your recently star lists. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_starlists` ✨ | `boolean` **[no]** | Display star lists | -| `plugin_starlists_limit` ✨ | `number` **[2]** *{1 ≤ đ‘Ĩ ≤ 100}* | Number of star lists to display | -| `plugin_starlists_limit_repositories` ✨ | `number` **[2]** *{0 ≤ đ‘Ĩ ≤ 100}* | Number of repositories to display per star lists | -| `plugin_starlists_shuffle_repositories` ✨ | `boolean` **[yes]** | Shuffle displayed repositories | -| `plugin_starlists_ignored` ✨ | `array` *(comma-separated)* **[]** | Star lists to skip | -| `plugin_starlists_only` ✨ | `array` *(comma-separated)* **[]** | Star lists to display | - - -Legend for option icons: -* ✨ Currently in beta-testing on `master`/`main` + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_starlistsDisplay star lists
✨ On master/main
+type: boolean +
+default: no
plugin_starlists_limitNumber of star lists to display
✨ On master/main
+type: number +
+(1 ≤ +đ‘Ĩ +≤ 100) +default: 2
plugin_starlists_limit_repositoriesNumber of repositories to display per star lists
✨ On master/main
+type: number +
+(0 ≤ +đ‘Ĩ +≤ 100) +default: 2
plugin_starlists_shuffle_repositoriesShuffle displayed repositories
✨ On master/main
+type: boolean +
+default: yes
plugin_starlists_ignoredStar lists to skip
✨ On master/main
+type: array +(comma-separated) +
plugin_starlists_onlyStar lists to display
✨ On master/main
+type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/stars/README.md b/source/plugins/stars/README.md index 6cb782e8..85251d0c 100644 --- a/source/plugins/stars/README.md +++ b/source/plugins/stars/README.md @@ -12,12 +12,32 @@ The *stars* plugin displays your recently starred repositories. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_stars` | `boolean` **[no]** | Display recently starred repositories | -| `plugin_stars_limit` | `number` **[4]** *{1 ≤ đ‘Ĩ ≤ 100}* | Maximum number of stars to display | - - + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_starsDisplay recently starred repositories
type: boolean +
+default: no
plugin_stars_limitMaximum number of stars to display
type: number +
+(1 ≤ +đ‘Ĩ +≤ 100) +default: 4
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/stock/README.md b/source/plugins/stock/README.md index 6a04f03d..4a19e346 100644 --- a/source/plugins/stock/README.md +++ b/source/plugins/stock/README.md @@ -21,17 +21,57 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_stock` | `boolean` **[no]** | Display stock prices of a given company | -| `plugin_stock_token` 🔐 | `token` **[]** | Yahoo Finance token | -| `plugin_stock_symbol` | `string` **[]** | Company stock symbol | -| `plugin_stock_duration` | `string` **[1d]** *{"1d", "5d", "1mo", "3mo", "6mo", "1y", "2y", "5y", "10y", "ytd", "max"}* | Time range to display | -| `plugin_stock_interval` | `string` **[5m]** *{"1m", "2m", "5m", "15m", "60m", "1d"}* | Time intervals between records | - - -Legend for option icons: -* 🔐 Value should be stored in repository secrets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_stockDisplay stock prices of a given company
type: boolean +
+default: no
plugin_stock_tokenYahoo Finance token
🔐 Token
+type: token +
plugin_stock_symbolCompany stock symbol
type: string +
plugin_stock_durationTime range to display
type: string +
+default: 1d
+allowed values:
  • 1d
  • 5d
  • 1mo
  • 3mo
  • 6mo
  • 1y
  • 2y
  • 5y
  • 10y
  • ytd
  • max
plugin_stock_intervalTime intervals between records
type: string +
+default: 5m
+allowed values:
  • 1m
  • 2m
  • 5m
  • 15m
  • 60m
  • 1d
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/support/README.md b/source/plugins/support/README.md index 1c1f6632..fe8ae1f7 100644 --- a/source/plugins/support/README.md +++ b/source/plugins/support/README.md @@ -14,11 +14,20 @@ An account on [GitHub Support Community](https://github.community/) is required #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_support` | `boolean` **[no]** | GitHub Community Support metrics | - - + + + + + + + + + + + +
TypeDescription
plugin_supportGitHub Community Support metrics
type: boolean +
+default: no
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/topics/README.md b/source/plugins/topics/README.md index 2807ebae..3e800f9c 100644 --- a/source/plugins/topics/README.md +++ b/source/plugins/topics/README.md @@ -20,14 +20,52 @@ This uses puppeteer to navigate through your starred topics page. #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_topics` | `boolean` **[no]** | Display starred topics | -| `plugin_topics_mode` | `string` **[starred]** *{"starred", "icons", "mastered"}* | Plugin mode | -| `plugin_topics_sort` | `string` **[stars]** *{"stars", "activity", "starred", "random"}* | Sorting method of starred topics | -| `plugin_topics_limit` | `number` **[15]** *{0 ≤ đ‘Ĩ ≤ 20}* | Maximum number of topics to display | - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_topicsDisplay starred topics
type: boolean +
+default: no
plugin_topics_modePlugin mode
type: string +
+default: starred
+allowed values:
  • starred
  • icons
  • mastered
plugin_topics_sortSorting method of starred topics
type: string +
+default: stars
+allowed values:
  • stars
  • activity
  • starred
  • random
plugin_topics_limitMaximum number of topics to display
type: number +
+(0 ≤ +đ‘Ĩ +≤ 20) +default: 15
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/traffic/README.md b/source/plugins/traffic/README.md index c6fcbdb8..ac1cb899 100644 --- a/source/plugins/traffic/README.md +++ b/source/plugins/traffic/README.md @@ -17,14 +17,30 @@ Because of GitHub REST API limitation, provided token requires full `repo` scope #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_traffic` | `boolean` **[no]** | Display repositories traffic metrics | -| `plugin_traffic_skipped` ⏊ | `array` *(comma-separated)* **[]** | Repositories to skip | - - -Legend for option icons: -* ⏊ Value inherits from its related global-level option + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_trafficDisplay repositories traffic metrics
type: boolean +
+default: no
plugin_traffic_skippedRepositories to skip
⏊ Inherits repositories_skipped
+type: array +(comma-separated) +
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/tweets/README.md b/source/plugins/tweets/README.md index 125d2c5c..cc403809 100644 --- a/source/plugins/tweets/README.md +++ b/source/plugins/tweets/README.md @@ -29,17 +29,59 @@ Create an app from your [developer dashboard](https://developer.twitter.com/en/p #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_tweets` | `boolean` **[no]** | Display recent tweets | -| `plugin_tweets_token` 🔐 | `token` **[]** | Twitter API token | -| `plugin_tweets_attachments` | `boolean` **[no]** | Display tweets attchments | -| `plugin_tweets_limit` | `number` **[2]** *{1 ≤ đ‘Ĩ ≤ 10}* | Maximum number of tweets to display | -| `plugin_tweets_user` | `string` **[*→ User attached twitter*]** | Twitter username | - - -Legend for option icons: -* 🔐 Value should be stored in repository secrets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_tweetsDisplay recent tweets
type: boolean +
+default: no
plugin_tweets_tokenTwitter API token
🔐 Token
+type: token +
plugin_tweets_attachmentsDisplay tweets attchments
type: boolean +
+default: no
plugin_tweets_limitMaximum number of tweets to display
type: number +
+(1 ≤ +đ‘Ĩ +≤ 10) +default: 2
plugin_tweets_userTwitter username
type: string +
+default: → User attached twitter
*[→ Full specification](metadata.yml)* diff --git a/source/plugins/wakatime/README.md b/source/plugins/wakatime/README.md index d7907575..a7b1dcb3 100644 --- a/source/plugins/wakatime/README.md +++ b/source/plugins/wakatime/README.md @@ -23,19 +23,78 @@ Then setup [WakaTime plugins](https://wakatime.com/plugins) to be ready to go! #### ➡ī¸ Available options -| Option | Type *(format)* **[default]** *{allowed values}* | Description | -| ------ | -------------------------------- | ----------- | -| `plugin_wakatime` | `boolean` **[no]** | Display WakaTime stats | -| `plugin_wakatime_token` 🔐 | `token` **[]** | WakaTime API token | -| `plugin_wakatime_days` | `string` **[7]** *{"7", "30", "180", "365"}* | WakaTime time range | -| `plugin_wakatime_sections` | `array` **[time, projects, projects-graphs, languages, languages-graphs, editors, os]** *{"time", "projects", "projects-graphs", "languages", "languages-graphs", "editors", "editors-graphs", "os", "os-graphs"}* | Sections to display | -| `plugin_wakatime_limit` | `number` **[5]** *{0 ≤ đ‘Ĩ}* | Maximum number of entries to display per graph | -| `plugin_wakatime_url` | `string` **[https://wakatime.com]** | Address where to reach your Wakatime instance | -| `plugin_wakatime_user` | `string` **[current]** | Your Wakatime user on the selfhosted Wakapi instance | - - -Legend for option icons: -* 🔐 Value should be stored in repository secrets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeDescription
plugin_wakatimeDisplay WakaTime stats
type: boolean +
+default: no
plugin_wakatime_tokenWakaTime API token
🔐 Token
+type: token +
plugin_wakatime_daysWakaTime time range
type: string +
+default: 7
+allowed values:
  • 7
  • 30
  • 180
  • 365
plugin_wakatime_sectionsSections to display
type: array +
+default: time, projects, projects-graphs, languages, languages-graphs, editors, os
+allowed values:
  • time
  • projects
  • projects-graphs
  • languages
  • languages-graphs
  • editors
  • editors-graphs
  • os
  • os-graphs
plugin_wakatime_limitMaximum number of entries to display per graph
type: number +
+(0 ≤ +đ‘Ĩ) +default: 5
plugin_wakatime_urlAddress where to reach your Wakatime instance
type: string +
+default: https://wakatime.com
plugin_wakatime_userYour Wakatime user on the selfhosted Wakapi instance
type: string +
+default: current
*[→ Full specification](metadata.yml)* diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md index 96d4758b..a9a86bc9 100644 --- a/source/templates/classic/README.md +++ b/source/templates/classic/README.md @@ -7,10 +7,10 @@ 🏆 📰 🌸 ♐ đŸ’Ŧ 🎟ī¸ đŸŽĢ 💡 🙋 📅 🈷ī¸ 👨‍đŸ’ģ đŸŽŧ 💉 🎩 ⏱ī¸ 🧑‍🤝‍🧑 💩 ✒ī¸ 🗂ī¸ 🎭 📓 đŸ—ŧ 📸 🌇 💕 🗨ī¸ ✨ đŸ’Ģ 🌟 💹 💭 📌 🧮 🐤 ⏰ - 👤 Users, đŸ‘Ĩ Organizations + 👤 Users đŸ‘Ĩ Organizations - *ī¸âƒŖ SVG, *ī¸âƒŖ PNG, *ī¸âƒŖ JPEG, #ī¸âƒŖ JSON + *ī¸âƒŖ SVG *ī¸âƒŖ PNG *ī¸âƒŖ JPEG #ī¸âƒŖ JSON diff --git a/source/templates/markdown/README.md b/source/templates/markdown/README.md index 22b68627..e88a1128 100644 --- a/source/templates/markdown/README.md +++ b/source/templates/markdown/README.md @@ -7,10 +7,10 @@ 📰 ✒ī¸ đŸ—ŧ 📌 🐤 ✓ embed() - 👤 Users, đŸ‘Ĩ Organizations + 👤 Users đŸ‘Ĩ Organizations - #ī¸âƒŖ JSON, 🔠 Markdown, 🔠 Markdown (PDF) + #ī¸âƒŖ JSON 🔠 Markdown 🔠 Markdown (PDF) diff --git a/source/templates/repository/README.md b/source/templates/repository/README.md index 437f9a87..2c5a33d6 100644 --- a/source/templates/repository/README.md +++ b/source/templates/repository/README.md @@ -7,10 +7,10 @@ 📰 🏅 🎟ī¸ 🙋 🈷ī¸ 📜 👨‍đŸ’ģ ⏱ī¸ 🧑‍🤝‍🧑 ✒ī¸ 🗂ī¸ đŸ—ŧ 📸 💕 ✨ 💹 🧮 - 📓 Repositories + 📓 Repositories - *ī¸âƒŖ SVG, *ī¸âƒŖ PNG, *ī¸âƒŖ JPEG, #ī¸âƒŖ JSON + *ī¸âƒŖ SVG *ī¸âƒŖ PNG *ī¸âƒŖ JPEG #ī¸âƒŖ JSON diff --git a/source/templates/terminal/README.md b/source/templates/terminal/README.md index 684667e5..12f3ade8 100644 --- a/source/templates/terminal/README.md +++ b/source/templates/terminal/README.md @@ -7,10 +7,10 @@ đŸŽĢ 📅 🈷ī¸ 👨‍đŸ’ģ ⏱ī¸ 📸 🧮 - 👤 Users, đŸ‘Ĩ Organizations + 👤 Users đŸ‘Ĩ Organizations - *ī¸âƒŖ SVG, *ī¸âƒŖ PNG, *ī¸âƒŖ JPEG, #ī¸âƒŖ JSON + *ī¸âƒŖ SVG *ī¸âƒŖ PNG *ī¸âƒŖ JPEG #ī¸âƒŖ JSON