Skip to content

Commit

Permalink
Docs: Clarify how to use local file paths with CLI
Browse files Browse the repository at this point in the history
Existing documentation focused on using the CLI with URLs
(e.g. `hint https://localhost:8080`). This change adds an example
showing usage with filesystem paths (e.g. `hint ./path/to/my.html`)

- - - - - - - - - - - - - - - - - - - -

Close #4256
  • Loading branch information
yinonov committed Jan 27, 2021
1 parent 2b3dff9 commit 792eb8f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/hint/docs/user-guide/index.md
Expand Up @@ -29,6 +29,12 @@ best practices that may be applied to your site, complete the following steps.
npx hint https://example.com
```

or

```bash
npx hint ./path/to/my.html
```

1. After the `webhint` process completes, a summary is presented in the bash
command-line interface with a link to a report file on your computer.
1. Navigate to the report file and open it. The report file outlines the
Expand Down

0 comments on commit 792eb8f

Please sign in to comment.