Skip to content

Fix README parameters table #4

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
samiahmedsiddiqui merged 1 commit into from
Oct 2, 2026
Merged

Fix README parameters table #4

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,6 @@ checkHttpStatus({
| `crawl` | String / Array | | Website URL to crawl. Pages are discovered by following internal links. |
| `urls` | Array | | URLs to check (with their redirects), without crawling. |
| `sitemaps` | Array | | *Optional.* Sitemap / sitemap index URLs. With `crawl`, their pages are crawled too and orphans are flagged; without it, their URLs are checked. |

Provide at least one of `crawl`, `urls` or `sitemaps`. For a full site audit, `crawl` on its own is enough.
| `include` | Array / String | | Only crawl URLs matching one of these rules. |
| `exclude` | Array / String | | Don't crawl URLs matching these rules. They are still listed and checked. |
| `maxPages` | Number | `1000` | Maximum pages to crawl. Later pages are listed as "Skipped (max pages)". |
Expand Down Expand Up @@ -186,6 +184,8 @@ Provide at least one of `crawl`, `urls` or `sitemaps`. For a full site audit, `c
| `onResult` | Function | | Called with each result as soon as its URL is checked (live results). |
| `onProgress` | Function | | Called with progress stats after each URL. |

Provide at least one of `crawl`, `urls` or `sitemaps`. For a full site audit, `crawl` on its own is enough.

Rules match as a case-insensitive substring (`/docs`), a wildcard
(`*/products/*`) or a regular expression (`/\/page\/\d+/`).

Expand Down
Loading