You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-1Lines changed: 26 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,13 @@ A Netlify plugin to generate a lighthouse report for every deploy
4
4
5
5
## Usage
6
6
7
-
You can install this plugin in the Netlify UI from this [direct in-app installation link](https://app.netlify.com/plugins/@netlify/plugin-lighthouse/install) or from the [Plugins directory](https://app.netlify.com/plugins).
7
+
If you would like to run the Lighthouse build plugin for multiple site paths, such as for the site root path and a contact page, we recommend installing the build plugin manually in the `netlify.toml` file.
8
+
9
+
### Install plugin through the Netlify UI
10
+
11
+
You can install this plugin in the Netlify UI from this [direct in-app installation link](https://app.netlify.com/plugins/@netlify/plugin-lighthouse/install) or from the [Plugins directory](https://app.netlify.com/plugins).
12
+
13
+
### Install plugin through the `netlify.toml` file
8
14
9
15
You can also install it manually:
10
16
@@ -60,6 +66,23 @@ You can customize the behavior via the `audits` input:
60
66
performance = 0.8
61
67
```
62
68
69
+
Example `netlify.toml` file that audits the site root path and a contact page:
70
+
71
+
```
72
+
[[plugins]]
73
+
package = "@netlify/plugin-lighthouse"
74
+
75
+
# Generate a Lighthouse report for the site's root path
76
+
[[plugins.inputs.audits]]
77
+
path = ""
78
+
79
+
# Generate a Lighthouse report for the contact site path
80
+
[[plugins.inputs.audits]]
81
+
path = "contact"
82
+
83
+
```
84
+
85
+
63
86
The lighthouse report results are automatically printed to the **Deploy log** in the Netlify UI. For example:
- The [Lighthouse Build Plugin](https://app.netlify.com/plugins/@netlify/plugin-lighthouse/install) must be installed on your site(s) in order for these score visualizations to be displayed.
107
130
- This Labs feature is currently only enabled at the user-level, so it will need to be enabled for each individual team member that wishes to see the Lighthouse scores displayed.
108
131
132
+
Learn more in our official [Labs docs](https://docs.netlify.com/netlify-labs/experimental-features/lighthouse-visualization/).
133
+
109
134
We have a lot planned for this feature and will be adding functionality regularly, but we'd also love to hear your thoughts. Please [share your feedback](https://netlify.qualtrics.com/jfe/form/SV_1NTbTSpvEi0UzWe) about this experimental feature and tell us what you think.
0 commit comments