2.6 KiB
2.6 KiB
🌇 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.
|
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
| Type | Description |
plugin_skyline |
Display GitHub Skyline 3D calendar |
type: boolean
default: no |
|
plugin_skyline_year |
Displayed year |
type: number
(2008 ≤
𝑥)
default: current-year |
|
plugin_skyline_frames |
Number of frames |
type: number
(1 ≤
𝑥
≤ 120)
default: 60 |
|
plugin_skyline_quality |
Image quality |
type: number
(0.1 ≤
𝑥
≤ 1)
default: 0.5 |
|
plugin_skyline_compatibility |
Compatibility mode |
type: boolean
default: no |
ℹ️ Examples workflows
name: GitHub Skyline
uses: lowlighter/metrics@latest
with:
filename: metrics.plugin.skyline.svg
token: NOT_NEEDED
base: ''
plugin_skyline: 'yes'
plugin_skyline_year: 2020
plugin_skyline_frames: 6
plugin_skyline_quality: 1