metrics/source/plugins/skyline/README.md

🌇 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).

ℹ️ Examples workflows

➡️ Available options for this plugin

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_skyline: yes
    plugin_skyline_year: 0    # Set to 0 to display current year
    plugin_skyline_frames: 60 # Use 60 frames (half-loop)