diff --git a/source/plugins/pagespeed/README.md b/source/plugins/pagespeed/README.md index f8f1add6..ed5d8515 100644 --- a/source/plugins/pagespeed/README.md +++ b/source/plugins/pagespeed/README.md @@ -1,32 +1,31 @@ - -### ⏱️ Website performances - -The *pagespeed* plugin adds the performance statistics of the website attached on your account: - + - + + + + + + + + + + + + + + +
-
PageSpeed scores - -
-
PageSpeed scores with detailed report - -
-
PageSpeed scores with a website screenshot - -
- -

⏱️ Website performances

This plugin adds performance statistics of a website. +It uses Google's PageSpeed API (same as web.dev), see performance scoring and score calculator for more informations about results.

+
Supported features
→ Full specification		📗 Classic template 📘 Repository template 📙 Terminal template
👤 Users 👥 Organizations 📓 Repositories
🗝️ plugin_pagespeed_token
+
PageSpeed scores
+
PageSpeed scores with detailed report
+
PageSpeed scores with a website screenshot
+ +
+ -These metrics are computed through [Google's PageSpeed API](https://developers.google.com/speed/docs/insights/v5/get-started), which yields the same results as [web.dev](https://web.dev). - -See [performance scoring](https://web.dev/performance-scoring/) and [score calculator](https://googlechrome.github.io/lighthouse/scorecalc/) for more informations about how PageSpeed compute these statistics. - -Although not mandatory, you can generate an API key for PageSpeed API [here](https://developers.google.com/speed/docs/insights/v5/get-started) to avoid hitting rate limiter. - -Expect 10 to 30 seconds to generate the results. - -#### ➡️ Available options +## ➡️ Available options @@ -35,7 +34,7 @@ Expect 10 to 30 seconds to generate the results. - @@ -55,7 +54,16 @@ Expect 10 to 30 seconds to generate the results. - @@ -65,7 +73,8 @@ Expect 10 to 30 seconds to generate the results. - @@ -76,6 +85,7 @@ Expect 10 to 30 seconds to generate the results. @@ -86,9 +96,7 @@ Expect 10 to 30 seconds to generate the results.
plugin_pagespeed

Display a website Google PageSpeed metrics

+

Enable pagespeed plugin
plugin_pagespeed_detailed

Detailed audit result

+

Detailed results

+

The following additional stats will be displayed:

+
    +
  • First Contentful Paint
    • +
  • Speed Index
    • +
  • Largest Contentful Paint
    • +
  • Time to Interactive
    • +
  • Total Blocking Time
    • +
  • Cumulative Layout Shift
    • +
plugin_pagespeed_screenshot

Display a screenshot of your website

+

Display a website screenshot

+

Significantly increase filesize
plugin_pagespeed_token

PageSpeed token

+

Although not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See PageSpeed documentation for more informations.
-*[→ Full specification](metadata.yml)* - -#### ℹ️ Examples workflows +## ℹ️ Examples workflows ```yaml diff --git a/source/plugins/pagespeed/metadata.yml b/source/plugins/pagespeed/metadata.yml index 296931b5..c5c378e2 100644 --- a/source/plugins/pagespeed/metadata.yml +++ b/source/plugins/pagespeed/metadata.yml @@ -1,5 +1,12 @@ name: "⏱️ Website performances" category: social +description: | + This plugin adds performance statistics of a website. + It uses [Google's PageSpeed API](https://developers.google.com/speed/docs/insights/v5/get-started) (same as [web.dev](https://web.dev)), see [performance scoring](https://web.dev/performance-scoring/) and [score calculator](https://googlechrome.github.io/lighthouse/scorecalc/) for more informations about results. +examples: + +PageSpeed scores: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.svg + PageSpeed scores with detailed report: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.detailed.svg + PageSpeed scores with a website screenshot: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.screenshot.svg index: 1 supports: - user @@ -8,37 +15,42 @@ supports: scopes: [] inputs: - # Enable or disable plugin plugin_pagespeed: - description: Display a website Google PageSpeed metrics + description: Enable pagespeed plugin type: boolean default: no - # Website to audit with PageSpeed plugin_pagespeed_url: description: Audited website type: string default: .user.website - # Display the following additional metrics from audited website: - # First Contentful Paint, Speed Index, Largest Contentful Paint, Time to Interactive, Total Blocking Time, Cumulative Layout Shift - # See https://web.dev/performance-scoring/ and https://googlechrome.github.io/lighthouse/scorecalc/ for more informations plugin_pagespeed_detailed: - description: Detailed audit result + description: | + Detailed results + + The following additional stats will be displayed: + - First Contentful Paint + - Speed Index + - Largest Contentful Paint + - Time to Interactive + - Total Blocking Time + - Cumulative Layout Shift type: boolean default: no - # Display a screenshot of audited website - # May increases significantly filesize plugin_pagespeed_screenshot: - description: Display a screenshot of your website + description: | + Display a website screenshot + + Significantly increase filesize type: boolean default: no - # PageSpeed API token - # This is optional, but providing it will avoid hitting rate-limiter - # See https://developers.google.com/speed/docs/insights/v5/get-started for more informations plugin_pagespeed_token: - description: PageSpeed token + description: | + PageSpeed token + + Although not mandatory, it strongly advised to create one to avoid triggering the rate limiter. See [PageSpeed documentation](https://developers.google.com/speed/docs/insights/v5/get-started) for more informations. type: token default: "" \ No newline at end of file