metrics/source/plugins/skyline/README.md

← Back to plugins index
🌇 GitHub Skyline
This plugin displays the 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

➡️ Available options

Option	Description
plugin_skyline	Enable skyline plugin
🌐 Web instances must configure settings.json: metrics.npm.optional.gifencoder type: boolean default: no
plugin_skyline_year	Displayed year
type: number (2008 ≤ 𝑥) default: current-year
plugin_skyline_frames	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 (1 ≤ 𝑥 ≤ 120) default: 60
plugin_skyline_quality	Image quality A higher image quality will increase file size.
type: number (0.1 ≤ 𝑥 ≤ 1) default: 0.5
plugin_skyline_compatibility	Compatibility mode This uses CSS animations rather than embedded GIF to support a wider range of browsers, like Firefox and Safari. Using this mode significantly increase file size as each frame is encoded separately
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