diff --git a/source/plugins/skyline/README.md b/source/plugins/skyline/README.md index 6eaad0d0..685fd399 100644 --- a/source/plugins/skyline/README.md +++ b/source/plugins/skyline/README.md @@ -1,19 +1,31 @@ -### 🌇 GitHub Skyline 3D calendar - -> âš ī¸ This plugin significantly increase file size, prefer using it as standalone. - -The *skyline* plugin lets you display your 3D commits calendar from [skyline.github.com](https://skyline.github.com/). - + - + + + + + + + + + + + + + + +
- - -

🌇 GitHub Skyline 3D calendar

This plugins lets you display your 3D commits calendar from skyline.github.com.

+
+

âš ī¸ This plugin significantly increase file size, consider using it as standalone.

+
+
Supported features
→ Full specification
📗 Classic template
👤 Users
No tokens are required for this plugin
+ + +
+ -This uses puppeteer to generate collect image frames, and use CSS animations to create an animated rendering (GIF images are not animated in GitHub flavored markdown rendering which is why this design choice was made). - -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -22,7 +34,7 @@ This uses puppeteer to generate collect image frames, and use CSS animations to - @@ -44,7 +56,9 @@ This uses puppeteer to generate collect image frames, and use CSS animations to - @@ -58,6 +72,7 @@ This uses puppeteer to generate collect image frames, and use CSS animations to @@ -71,6 +86,8 @@ This uses puppeteer to generate collect image frames, and use CSS animations to @@ -81,9 +98,7 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
plugin_skyline

Display GitHub Skyline 3D calendar

+

Enable skyline plugin

plugin_skyline_frames

Number of frames

+

Frames count

+

Use 120 for a full-loop and 60 for a half-loop. +A higher number of frames will increase file size.

plugin_skyline_quality

Image quality

+

A higher image quality will increase file size.

plugin_skyline_compatibility

Compatibility mode

+

This uses CSS animations rather than embedded GIF to support a widerr range of browser, like Firefox and Safari. +Using this mode significantly increase file size as each frame is encoded separately

-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -99,4 +114,4 @@ with: plugin_skyline_quality: 1 ``` - \ No newline at end of file + diff --git a/source/plugins/skyline/metadata.yml b/source/plugins/skyline/metadata.yml index 5a9383be..0a019b6a 100644 --- a/source/plugins/skyline/metadata.yml +++ b/source/plugins/skyline/metadata.yml @@ -1,44 +1,54 @@ name: "🌇 GitHub Skyline 3D calendar" category: github +description: | + This plugins lets you display your 3D commits calendar from [skyline.github.com](https://skyline.github.com/). + + > âš ī¸ This plugin significantly increase file size, consider using it as standalone. +examples: + default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.skyline.svg index: 25 supports: - user scopes: [] inputs: - # Enable or disable plugin plugin_skyline: - description: Display GitHub Skyline 3D calendar + description: Enable skyline plugin type: boolean default: no - # Displayed year plugin_skyline_year: description: Displayed year type: number - default: "current-year" + default: current-year min: 2008 - # Number of frames - # Use 120 for a full-loop and 60 for a half-loop plugin_skyline_frames: - description: Number of frames + description: | + Frames count + + Use 120 for a full-loop and 60 for a half-loop. + A higher number of frames will increase file size. type: number default: 60 min: 1 max: 120 - # Image quality plugin_skyline_quality: - description: Image quality + description: | + Image quality + + A higher image quality will increase file size. type: number default: 0.5 min: 0.1 max: 1 - # This uses CSS animations instead of GIF to support a wider range of browser like FireFox and Safari - # Using this mode significantly increase file size as each frame is encoded separately plugin_skyline_compatibility: - description: Compatibility mode + description: | + Compatibility mode + + This uses CSS animations rather than embedded GIF to support a widerr range of browser, like Firefox and Safari. + Using this mode significantly increase file size as each frame is encoded separately type: boolean default: no