Skip to content

Commit c448486

Browse files
authoredMar 1, 2023
Merge pull request #175 from mgrojo/patch-2
Document interpration of filenames and paths in `config-file`
2 parents 21ae1b5 + 26b1f3d commit c448486

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ You customize the action by using the following variables:
5252
|:----------|:--------------|:-----------|
5353
|`use-quiet-mode`| Specify `yes` to only show errors in output.| `no`|
5454
|`use-verbose-mode`|Specify `yes` to show detailed HTTP status for checked links. |`no` |
55-
|`config-file`|Specify a [custom configuration file](https://github.com/tcort/markdown-link-check#config-file-format) for markdown-link-check. You can use it to remove false-positives by specifying replacement patterns and ignore patterns.|`mlc_config.json`|
55+
|`config-file`|Specify a [custom configuration file](https://github.com/tcort/markdown-link-check#config-file-format) for markdown-link-check. You can use it to remove false-positives by specifying replacement patterns and ignore patterns. The filename is interpreted relative to the repository root.|`mlc_config.json`|
5656
|`folder-path` |By default the `github-action-markdown-link-check` action checks for all markdown files in your repository. Use this option to limit checks to only specific folders. Use comma separated values for checking multiple folders. |`.` |
5757
|`max-depth` |Specify how many levels deep you want to check in the directory structure. The default value is `-1` which means check all levels.|`-1` |
5858
|`check-modified-files-only` |Use this variable to only check modified markdown files instead of checking all markdown files. The action uses `git` to find modified markdown files. Only use this variable when you run the action to check pull requests.|`no`|

0 commit comments

Comments
 (0)
Please sign in to comment.