diff --git a/.github/readme/partials/documentation/compatibility.md b/.github/readme/partials/documentation/compatibility.md index 642f3174..006779b7 100644 --- a/.github/readme/partials/documentation/compatibility.md +++ b/.github/readme/partials/documentation/compatibility.md @@ -39,6 +39,7 @@ โœ’๏ธ ๐Ÿ—ผ โฐ + ๐Ÿ—ณ๏ธ ๐Ÿ“— Classic template @@ -78,6 +79,7 @@ โœ”๏ธ โœ”๏ธ โœ”๏ธ + โœ”๏ธ ๐Ÿ“˜ Repository template @@ -117,6 +119,7 @@ โœ”๏ธ โœ”๏ธ โŒ + โŒ ๐Ÿ“™ Terminal template @@ -156,6 +159,7 @@ โŒ โŒ โŒ + โŒ ๐Ÿ“’ Markdown template @@ -195,9 +199,10 @@ โœ”๏ธ โœ”๏ธ โœ“ + โœ“ - + Mode/Plugin @@ -237,6 +242,7 @@ โœ’๏ธ ๐Ÿ—ผ โฐ + ๐Ÿ—ณ๏ธ ๐Ÿ‘ค User @@ -276,6 +282,7 @@ โœ”๏ธ โœ”๏ธ โœ”๏ธ + โœ”๏ธ ๐Ÿ‘ฅ Organization @@ -315,6 +322,7 @@ โœ”๏ธ โœ”๏ธ โŒ + โŒ ๐Ÿ““ Repository @@ -354,6 +362,7 @@ โœ”๏ธ โœ”๏ธ โŒ + โŒ diff --git a/README.md b/README.md index fe20da28..27d9bc6b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Generate metrics that can be embedded everywhere, including your GitHub profile -

๐Ÿงฉ Customizable with 40 plugins and 285 options!

+

๐Ÿงฉ Customizable with 42 plugins and 296 options!

@@ -289,6 +289,17 @@ Generate metrics that can be embedded everywhere, including your GitHub profile + + ๐Ÿ—ณ๏ธ Leetcode + + + + + + + + + ๐ŸŽฒ See also community plugins @@ -438,6 +449,7 @@ Plugins provide additional content and lets you customize rendered metrics. * [๐Ÿงฎ Repositories traffic `traffic`](/source/plugins/traffic/README.md) * **Social plugins** * [๐ŸŒธ Anilist watch list and reading list `anilist`](/source/plugins/anilist/README.md) + * [๐Ÿ—ณ๏ธ Leetcode `leetcode`](/source/plugins/leetcode/README.md) * [๐ŸŽผ Music activity and suggestions `music`](/source/plugins/music/README.md) * [โฑ๏ธ Google PageSpeed `pagespeed`](/source/plugins/pagespeed/README.md) * [โœ’๏ธ Recent posts `posts`](/source/plugins/posts/README.md) @@ -448,6 +460,7 @@ Plugins provide additional content and lets you customize rendered metrics. **๐ŸŽฒ Maintained by community** * **[Community plugins](/source/plugins/community/README.md)** + * [โ™Ÿ๏ธ Chess `chess`](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿฅ  Fortune `fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿ’‰ Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [๐Ÿ’ฉ PoopMap plugin `poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) diff --git a/action.yml b/action.yml index 808d23cf..54265f21 100644 --- a/action.yml +++ b/action.yml @@ -18,6 +18,10 @@ inputs: description: Show `Available for hire!` in header section default: + base_skip: + description: Skip base content + default: + repositories: description: Fetched repositories default: @@ -1172,6 +1176,52 @@ inputs: description: Repositories visibility default: + # ==================================================================================== + # ๐Ÿ—ณ๏ธ Leetcode + + plugin_leetcode: + description: Enable leetcode plugin + default: + + plugin_leetcode_user: + description: LeetCode login + default: + + plugin_leetcode_sections: + description: Displayed sections + default: + + plugin_leetcode_limit_skills: + description: Display limit (skills) + default: + + plugin_leetcode_limit_recent: + description: Display limit (recent) + default: + + # ==================================================================================== + # โ™Ÿ๏ธ Chess + + plugin_chess: + description: Enable chess plugin + default: + + plugin_chess_token: + description: Chess platform token + default: + + plugin_chess_user: + description: AniList login + default: + + plugin_chess_platform: + description: Chess platform + default: + + plugin_chess_animation: + description: Animation settings + default: + # ==================================================================================== # ๐Ÿฅ  Fortune diff --git a/settings.example.json b/settings.example.json index a0c3fce2..ffdc7de2 100644 --- a/settings.example.json +++ b/settings.example.json @@ -174,6 +174,13 @@ "token": "WakaTime API token", "enabled": false, "//": "Enable wakatime plugin" }, + "leetcode":{ + "enabled": false, "//": "Enable leetcode plugin" + }, + "chess":{ + "token": "Chess platform token", + "enabled": false, "//": "Enable chess plugin" + }, "fortune":{ "enabled": false, "//": "Enable fortune plugin" }, diff --git a/source/plugins/README.md b/source/plugins/README.md index 87c45893..3f53daac 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -37,6 +37,7 @@ Plugins provide additional content and lets you customize rendered metrics. * [๐Ÿงฎ Repositories traffic `traffic`](/source/plugins/traffic/README.md) * **Social plugins** * [๐ŸŒธ Anilist watch list and reading list `anilist`](/source/plugins/anilist/README.md) + * [๐Ÿ—ณ๏ธ Leetcode `leetcode`](/source/plugins/leetcode/README.md) * [๐ŸŽผ Music activity and suggestions `music`](/source/plugins/music/README.md) * [โฑ๏ธ Google PageSpeed `pagespeed`](/source/plugins/pagespeed/README.md) * [โœ’๏ธ Recent posts `posts`](/source/plugins/posts/README.md) @@ -47,6 +48,7 @@ Plugins provide additional content and lets you customize rendered metrics. **๐ŸŽฒ Maintained by community** * **[Community plugins](/source/plugins/community/README.md)** + * [โ™Ÿ๏ธ Chess `chess`](/source/plugins/community/chess/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿฅ  Fortune `fortune`](/source/plugins/community/fortune/README.md) by [@lowlighter](https://github.com/lowlighter) * [๐Ÿ’‰ Nightscout `nightscout`](/source/plugins/community/nightscout/README.md) by [@legoandmars](https://github.com/legoandmars) * [๐Ÿ’ฉ PoopMap plugin `poopmap`](/source/plugins/community/poopmap/README.md) by [@matievisthekat](https://github.com/matievisthekat) diff --git a/source/plugins/base/README.md b/source/plugins/base/README.md index 168fafcf..2151e439 100644 --- a/source/plugins/base/README.md +++ b/source/plugins/base/README.md @@ -85,6 +85,21 @@ This currently improves the accuracy of the following statistics:

type: boolean
+default: no
+ + +

base_skip

+

Skip base content

+
+

โš ๏ธ Any plugin that relies on base content data may break! +Only use this option when using a plugin that can be configured with token: NOT_NEEDED

+
+ + + + โœจ On master/main
+type: boolean +
default: no
diff --git a/source/plugins/community/README.md b/source/plugins/community/README.md index bd975e31..66774ba5 100644 --- a/source/plugins/community/README.md +++ b/source/plugins/community/README.md @@ -3,41 +3,44 @@

๐ŸŽฒ Community plugins

Additional plugins maintained by community for even more features! + โ™Ÿ๏ธ Chess ๐Ÿฅ  Fortune - ๐Ÿ’‰ Nightscout + + + + + + ๐Ÿ’‰ Nightscout + ๐Ÿ’ฉ PoopMap plugin + + - - ๐Ÿ’ฉ PoopMap plugin - ๐Ÿ“ธ Website screenshot - - + + ๐Ÿ“ธ Website screenshot + ๐Ÿ’น Stock prices + + - - ๐Ÿ’น Stock prices - - - - diff --git a/source/plugins/community/chess/README.md b/source/plugins/community/chess/README.md index 1b81045c..0bbdf2eb 100644 --- a/source/plugins/community/chess/README.md +++ b/source/plugins/community/chess/README.md @@ -1,9 +1,110 @@ + + + + + + + + + + + + + + + + + + + +
โ† Back to plugins index

โ™Ÿ๏ธ Chess

This plugin displays the last game you played on a supported chess platform.

+
โš ๏ธ Disclaimer

This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with any of the supported provider. +All product and company names are trademarksโ„ข or registeredยฎ trademarks of their respective holders.

+
Authors@lowlighter
Supported features
โ†’ Full specification		๐Ÿ“— Classic template
๐Ÿ‘ค Users ๐Ÿ‘ฅ Organizations ๐Ÿ““ Repositories
๐Ÿ—๏ธ plugin_chess_token
+ + +
## โžก๏ธ Available options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription

plugin_chess

Enable chess plugin

+
โœจ On master/main
+type: boolean +
+default: no

plugin_chess_token

Chess platform token

+
๐Ÿ” Token
+โœจ On master/main
+๐ŸŒ Web instances must configure settings.json: +
    +
  • metrics.api.chess.any
    • +
+type: token +

plugin_chess_user

AniList login

+
โฏ๏ธ Cannot be preset
+โœจ On master/main
+type: string +
+default: โ†’ User login

plugin_chess_platform

Chess platform

+
โœจ On master/main
+type: string +
+allowed values:
  • lichess.org

plugin_chess_animation

Animation settings

+
    +
  • size is the size of a single chessboard square in pixels (board will be 8 times larger)
    • +
  • delay is the delay before starting animation (in seconds)
    • +
  • duration is the duration of the animation of a move (in seconds)
    • +
+
โœจ On master/main
+type: json +
+default:
โ†’ Click to expand
{
+  "size": 40,
+  "delay": 3,
+  "duration": 0.6
+}
+

## ๐Ÿ—๏ธ Obtaining a lichess.org token @@ -23,4 +124,16 @@ Create token and store it in your secrets: ## โ„น๏ธ Examples workflows +```yaml +name: Last chess game from lichess.org +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.chess.svg + token: NOT_NEEDED + base: "" + plugin_chess: yes + plugin_chess_token: ${{ secrets.CHESS_TOKEN }} + plugin_chess_platform: lichess.org + +``` diff --git a/source/plugins/leetcode/README.md b/source/plugins/leetcode/README.md index 3eff2a87..d0b04870 100644 --- a/source/plugins/leetcode/README.md +++ b/source/plugins/leetcode/README.md @@ -1,12 +1,122 @@ + + + + + + + + + + + + + + + + + + +
โ† Back to plugins index

๐Ÿ—ณ๏ธ Leetcode

This plugin displays statistics from a LeetCode account.

+
โš ๏ธ Disclaimer

This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with LeetCode. +All product and company names are trademarksโ„ข or registeredยฎ trademarks of their respective holders.

+
Supported features
โ†’ Full specification		๐Ÿ“— Classic template
๐Ÿ‘ค Users
No tokens are required for this plugin
+ + +
## โžก๏ธ Available options + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription

plugin_leetcode

Enable leetcode plugin

+
โœจ On master/main
+type: boolean +
+default: no

plugin_leetcode_user

LeetCode login

+
โฏ๏ธ Cannot be preset
+โœจ On master/main
+type: string +
+default: โ†’ User login

plugin_leetcode_sections

Displayed sections

+
    +
  • solved will display solved problems scores
    • +
  • skills will display solved problems tagged skills
    • +
  • recent will display recent submissions
    • +
+
โœจ On master/main
+type: array +(comma-separated) +
+default: solved
+allowed values:
  • solved
  • skills
  • recent

plugin_leetcode_limit_skills

Display limit (skills)

+
โœจ On master/main
+type: number +(0 โ‰ค +๐‘ฅ) +
+zero behaviour: disable
+default: 10

plugin_leetcode_limit_recent

Display limit (recent)

+
โœจ On master/main
+type: number +(1 โ‰ค +๐‘ฅ +โ‰ค 15) +
+default: 2
## โ„น๏ธ Examples workflows +```yaml +name: LeetCode +uses: lowlighter/metrics@latest +with: + filename: metrics.plugin.leetcode.svg + token: NOT_NEEDED + base: "" + plugin_leetcode: yes + plugin_leetcode_sections: solved, skills, recent + +``` diff --git a/source/templates/classic/README.md b/source/templates/classic/README.md index baf657ea..26976fee 100644 --- a/source/templates/classic/README.md +++ b/source/templates/classic/README.md @@ -7,7 +7,7 @@ This is also the default template.

Supported features
โ†’ Full specification - ๐Ÿ† ๐Ÿ“ฐ ๐ŸŒธ ๐Ÿ“† โ™ ๐Ÿฅ  ๐Ÿ’‰ ๐Ÿ’ฉ ๐Ÿ“ธ ๐Ÿ’น ๐Ÿ’ฌ ๐ŸŽŸ๏ธ ๐ŸŽซ ๐Ÿ’ก ๐Ÿ™‹ ๐Ÿ“… ๐Ÿˆท๏ธ ๐Ÿ‘จโ€๐Ÿ’ป ๐ŸŽผ ๐ŸŽฉ โฑ๏ธ ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ โœ’๏ธ ๐Ÿ—‚๏ธ ๐ŸŽญ ๐Ÿ““ ๐Ÿ—ผ ๐ŸŒ‡ ๐Ÿ’• ๐Ÿ—จ๏ธ โœจ ๐Ÿ’ซ ๐ŸŒŸ ๐Ÿ’ญ ๐Ÿ“Œ ๐Ÿงฎ ๐Ÿค โฐ + ๐Ÿ† ๐Ÿ“ฐ ๐ŸŒธ ๐Ÿ“† โ™ โ™Ÿ๏ธ ๐Ÿฅ  ๐Ÿ’‰ ๐Ÿ’ฉ ๐Ÿ“ธ ๐Ÿ’น ๐Ÿ’ฌ ๐ŸŽŸ๏ธ ๐ŸŽซ ๐Ÿ’ก ๐Ÿ™‹ ๐Ÿ“… ๐Ÿˆท๏ธ ๐Ÿ—ณ๏ธ ๐Ÿ‘จโ€๐Ÿ’ป ๐ŸŽผ ๐ŸŽฉ โฑ๏ธ ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ โœ’๏ธ ๐Ÿ—‚๏ธ ๐ŸŽญ ๐Ÿ““ ๐Ÿ—ผ ๐ŸŒ‡ ๐Ÿ’• ๐Ÿ—จ๏ธ โœจ ๐Ÿ’ซ ๐ŸŒŸ ๐Ÿ’ญ ๐Ÿ“Œ ๐Ÿงฎ ๐Ÿค โฐ ๐Ÿ‘ค Users ๐Ÿ‘ฅ Organizations