Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add browser extension documentation
- Loading branch information
Showing
3 changed files
with
28 additions
and
0 deletions.
There are no files selected for viewing
28 changes: 28 additions & 0 deletions
28
packages/hint/docs/user-guide/extensions/extension-browser.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# webhint browser extension | ||
|
||
The webhint browser extension surfaces webhint's best practices and hints | ||
directly in your browser's DevTools. It provides a visual interface that | ||
allows you to run and re-run site scans that test against all browsers and | ||
all hint types or to just a select few. | ||
|
||
![The webhint browser extension running against webhint.io.](images/extension-browser-0.png) | ||
|
||
## Installation | ||
|
||
To install the browser extension, click one of the links below and follow the | ||
installation instructions. | ||
|
||
> Note: The links below redirect to externally-hosted storefronts. | ||
- [webhint browser extension for Google Chrome](https://chrome.google.com/webstore/detail/webhint/gccemnpihkbgkdmoogenkbkckppadcag) | ||
- [webhint browser extension for Microsoft Edge (Chromium)](https://microsoftedge.microsoft.com/insider-addons/detail/mlgfbihcfnkaenjpdcngdnhcpkdmcdee) | ||
- [webhint browser extension for Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/webhint/) | ||
|
||
## Usage | ||
|
||
Open DevTools in the browser. Once the webhint extension is installed, it will | ||
appear as a tab within DevTools. From here, you can customize the scan by | ||
selecting which hint categories, browsers, or resources to include or exclude. | ||
Click "Start scan" to begin scanning the site. | ||
|
||
![Choosing settings for a webhint site scan.](images/extension-browser-1.png) |
Binary file added
BIN
+235 KB
packages/hint/docs/user-guide/extensions/images/extension-browser-0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+61.6 KB
packages/hint/docs/user-guide/extensions/images/extension-browser-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.