README

<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>⏱️ Google PageSpeed</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays performance statistics of a website.</p> <p>It uses <a href="https://developers.google.com/speed/docs/insights/v5/get-started">Google&#39;s PageSpeed API</a> (same as <a href="https://web.dev">web.dev</a>), see <a href="https://web.dev/performance-scoring/">performance scoring</a> and <a href="https://googlechrome.github.io/lighthouse/scorecalc/">score calculator</a> for more informations about results.</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://pagespeed.web.dev/">Google PageSpeed</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </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> <a href="/source/templates/repository/README.md"><code>📘 Repository template</code></a> <a href="/source/templates/terminal/README.md"><code>📙 Terminal template</code></a></td> </tr> <tr> <td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td> </tr> <tr> <td><code>🗝️ plugin_pagespeed_token</code></td> </tr> <tr> <td colspan="2" align="center"> <details open><summary>PageSpeed scores</summary></img></details> <details><summary>PageSpeed scores with detailed report</summary></img></details> <details><summary>PageSpeed scores with a website screenshot</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_pagespeed</code></h4></td> <td rowspan="2"><p>Enable pagespeed plugin</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_pagespeed_token</code></h4></td> <td rowspan="2"><p>PageSpeed token</p> <blockquote> <p>⚠️ While not mandatory, it is strongly advised pass a token to avoid triggering the rate limiter. See <a href="https://developers.google.com/speed/docs/insights/v5/get-started">PageSpeed documentation</a> for more informations.</p> </blockquote> </td> </tr> <tr> <td nowrap="nowrap">🔐 Token

🌐 Web instances must configure <code>settings.json</code>:

<ul> <li><i>metrics.api.google.pagespeed</i></li> </ul> <b>type:</b> <code>token</code> </td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_pagespeed_url</code></h4></td> <td rowspan="2"><p>Audited website</p> </td> </tr> <tr> <td nowrap="nowrap">⏯️ Cannot be preset

<b>type:</b> <code>string</code>

<b>default:</b> <code>→ User attached website</code>

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_pagespeed_detailed</code></h4></td> <td rowspan="2"><p>Detailed results</p> <p>The following additional stats will be displayed:</p> <ul> <li>First Contentful Paint</li> <li>Speed Index</li> <li>Largest Contentful Paint</li> <li>Time to Interactive</li> <li>Total Blocking Time</li> <li>Cumulative Layout Shift</li> </ul> </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_pagespeed_screenshot</code></h4></td> <td rowspan="2"><p>Website screenshot</p> <p>Significantly increase filesize</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_pagespeed_pwa</code></h4></td> <td rowspan="2"><p>PWA Status</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

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

ℹ️ Examples workflows

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