Skip to content

docs: Update usage in README.md with output from --help #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WillGibson merged 1 commit into from
Apr 7, 2025
Merged

docs: Update usage in README.md with output from --help #417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,18 +184,20 @@ find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check
#### Usage

```shell
Usage: markdown-link-check [options] [filenameOrDirectorynameOrUrl]
Usage: markdown-link-check [options] [filenamesOrDirectorynamesOrUrls...]

Options:
-p, --progress show progress bar
-c, --config [config] apply a config file (JSON), holding e.g. url specific header configuration
-q, --quiet displays errors only
-v, --verbose displays detailed error information
-a, --alive <code> comma separated list of HTTP code to be considered as alive
-r, --retry retry after the duration indicated in 'retry-after' header when HTTP code is 429
-h, --help display help for command
-V, --version display version string (e.g. `1.2.3`)
, --projectBaseUrl <url> the URL to use for {{BASEURL}} replacement
-V, --version output the version number
-p, --progress show progress bar
-c, --config [config] apply a config file (JSON), holding e.g. url specific header configuration
-q, --quiet displays errors only
-v, --verbose displays detailed error information
-i, --ignore <paths> ignore input paths including an ignore path
-a, --alive <code> comma separated list of HTTP codes to be considered as alive
-r, --retry retry after the duration indicated in 'retry-after' header when HTTP code is 429
--reporters <names> specify reporters to use
--projectBaseUrl <url> the URL to use for {{BASEURL}} replacement
-h, --help display help for command
```

##### Config file format
Expand Down