-
-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add documentation on using the param when testing local files (as in …
…alternate)
- Loading branch information
Showing
1 changed file
with
10 additions
and
0 deletions.
There are no files selected for viewing
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 |
---|---|---|
|
@@ -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. | ||
|