Skip to content

Commit

Permalink
add documentation on using the param when testing local files (as in …
Browse files Browse the repository at this point in the history
…alternate)
  • Loading branch information
tgaff committed Oct 20, 2023
1 parent 2ac9f03 commit 1ce9747
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,16 @@ jobs:
fail: true
```

You may want to add additional arguments to the above. In particular if you're testing a site directly from the file-system (as in the above), you'll likely want to set the argument `--base .` to ensure that **all links** in the files are tested. You don't need to do this if you're testing a hosted site.

```
- name: Link Checker
uses: lycheeverse/[email protected]
with:
fail: true
args: "--verbose --no-progress './**/*.md' './**/*.html' './**/*.rst'" --base .
```
## Passing arguments
This action uses [lychee] for link checking.
Expand Down

0 comments on commit 1ce9747

Please sign in to comment.