Google lighthouse stats of your website that you can put in readme
Embed your website's pagespeed score to your readme
PageSpeed Insights analyzes the content of a web page, then generates suggestions to make that page faster. Learn more.
Important note: Do not embed url to readme, instead embed generated svg
The api is called from https://pagespeed-insights.herokuapp.com
In simple form it will return result for all categories for desktop version of your website. Replace your_website_url
with your website's url
https://pagespeed-insights.herokuapp.com?url=your_website_url
For example
https://pagespeed-insights.herokuapp.com?url=https://ankurparihar.github.io
Default result is theme-agnostic i.e. looks good in both light and dark environment. But you can force one of two additional themes that are light
and dark
.
https://pagespeed-insights.herokuapp.com?url=your_website_url&theme=dark
Strategy specifies the type of device your website is audited for. You can specify strategy
as either mobile
or desktop
. If none is specified desktop
is chosen
https://pagespeed-insights.herokuapp.com?url=your_website_url&strategy=mobile
There are 5 categories (in order)
Category Name | param |
---|---|
Performance | performance |
Accessibility | accessibility |
Best Practices | best-practices |
SEO | seo |
Progressive Web App | pwa |
If not specified, all the categories are evaluated. But you can specify only categories which you want to evaluate. The category
parameter is comma-separated category indicators.
Examples:
https://pagespeed-insights.herokuapp.com?url=your_website_url&categories=performance
https://pagespeed-insights.herokuapp.com?url=your_website_url&categories=performance,accessibility,best-practices,seo
Order of categories is preserved
https://pagespeed-insights.herokuapp.com?url=your_website_url&categories=seo,performance,accessibility
Additional options you can specify in query parameter
Name (default) | Description |
---|---|
perfTestCount (1) |
Specify how many times performance test to run |
After downloading svg you can embed into readme as following
![alt text](path/to/svg "tooltip text")
<p align="center"> <!-- (optional) center align -->
<img src="/path/to/svg" width="XXXpx">
</p>