README

<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>🌇 GitHub Skyline</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays the 3D commits calendar from <a href="https://skyline.github.com/">skyline.github.com</a>.</p> </td></tr> <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="https://github.com">GitHub</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr><th>ℹ Additional notes</th><td><blockquote> <p>⚠️ This plugin significantly increase file size, consider using it as standalone.</p> </blockquote> </td></tr> <tr> <th rowspan="3">Supported features _{<a href="metadata.yml">→ Full specification</a>}</th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td> </tr> <tr> <td><code>👤 Users</code></td> </tr> <tr> <td><i>No tokens are required for this plugin</i></td> </tr> <tr> <td colspan="2" align="center"> <details open><summary>GitHub Skyline</summary></img></details> <details><summary>GitHub City</summary></img></details> </tr> </table> <!--/header-->

➡️ Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_skyline</code></h4></td> <td rowspan="2"><p>Enable skyline plugin</p> </td> </tr> <tr> <td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code>: <ul> <li><i>metrics.cpu.overuse</i></li> <li><i>metrics.npm.optional.gifencoder</i></li> <li><i>metrics.run.puppeteer.scrapping</i></li> </ul> <b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_skyline_year</code></h4></td> <td rowspan="2"><p>Displayed year</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(2008 ≤ 𝑥)</i>

<b>default:</b> current-year

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_skyline_frames</code></h4></td> <td rowspan="2"><p>Frames count</p> <p>Use 120 for a full-loop and 60 for a half-loop. A higher number of frames will increase file size.</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(1 ≤ 𝑥 ≤ 120)</i>

<b>default:</b> 60

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_skyline_quality</code></h4></td> <td rowspan="2"><p>Image quality</p> <p>A higher image quality will increase file size.</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0.1 ≤ 𝑥 ≤ 1)</i>

<b>default:</b> 0.5

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_skyline_compatibility</code></h4></td> <td rowspan="2"><p>Compatibility mode</p> <p>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</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_skyline_settings</code></h4></td> <td rowspan="2"><p>Advanced settings</p> <p>Can be configured to use alternate skyline websites different from <a href="https://skyline.github.com">skyline.github.com</a>, such as <a href="https://github.com/honzaap/GithubCity">honzaap&#39;s GitHub City</a>.</p> <ul> <li><code>url</code>: Target URL (mandatory)</li> <li><code>ready</code>: Readiness condition (A JS function that returns a boolean)</li> <li><code>wait</code>: Time to wait after readiness condition is met (in seconds)</li> <li><code>hide</code>: HTML elements to hide (A CSS selector)</li> </ul> <p>For <code>url</code> and <code>ready</code> options, <code>${login}</code> and <code>${year}</code> will be respectively templated to user&#39;s login and specified year</p> </td> </tr> <tr> <td nowrap="nowrap">🌐 Web instances must configure <code>settings.json</code>: <ul> <li><i>metrics.run.puppeteer.user.js</i></li> </ul> <b>type:</b> <code>json</code>

<b>default:</b> <details><summary>→ Click to expand</summary><pre language="json"><code>{ "url": "https://skyline.github.com/${login}/${year}", "ready": "[...document.querySelectorAll('span')].map(span => span.innerText).includes('Share on Twitter')", "wait": 1, "hide": "button, footer, a" } </code></pre></details>

</td> </tr> </table> <!--/options-->

ℹ️ Examples workflows

<!--examples--> <!--/examples-->