actions-marketplace-validations/Linkinator

A GitHub Action that checks your README and other markdown for 404s.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
pathsPaths to scan for 404s. Defaults to *.md.no*.md
concurrencyThe number of connections to make simultaneously.no100
recurseRecursively follow links on the same root domain.nofalse
linksToSkipList of urls in regexy form to not include in the check.no
skipList of urls in regexy form to not include in the check.no
timeoutRequest timeout in ms. Defaults to 0 (no timeout).no0
markdownAutomatically parse and scan markdown if scanning from a location on disk.notrue
serverRootWhen scanning a locally directory, customize the location on disk where the server is started.no
directoryListingInclude an automatic directory index file when linking to a directory.nofalse
retryAutomatically retry requests that return HTTP 429 responses and include a "retry-after" header.nofalse
retryErrorsAutomatically retry requests that return 5xx or network error responses.nofalse
retryErrorsCountThe number of times to retry requests that return 5xx or network error responses. Defaults to 3.no3
retryErrorsJitterThe maximum jitter in milliseconds to apply to retry delays. Defaults to 2000.no2000
userAgentCustom User-Agent header to use for requests.no
verbosityOverride the default verbosity for this command. Available options are "DEBUG", "INFO", "WARNING", "ERROR", and "NONE". Defaults to "WARNING".noWARNING
configPath to a config file to use. Looks for `linkinator.config.json` by default. Options defined via the GitHub Action config will take precedence.no
urlRewriteSearchPattern to search for in urls. Must be used with `urlRewriteReplace`.no
urlRewriteReplaceExpression used to replace search content. Must be used with `urlRewriteSearch`.no
allowInsecureCertsAllow checking links with insecure certificates. Useful for local development with self-signed certificates.nofalse
requireHttpsRequire all links to use HTTPS. Any HTTP links will be treated as broken.nofalse
cleanUrlsEnable support for clean URLs (extensionless paths). Allows validation of URLs without file extensions, useful for modern static hosting.nofalse
checkCssEnable parsing and extraction of URLs from CSS files, style blocks, and inline styles.nofalse
checkFragmentsEnable validation of fragment identifiers (anchor links) on HTML pages.nofalse
statusCodesJSON object mapping HTTP status codes to actions (ok, warn, skip, error). Supports patterns like 4xx or 5xx. Example - {"404":"error","5xx":"warn"}no
redirectsHow to handle HTTP redirects. Options - "allow" (default), "warn", or "error".noallow
namedescription
resultsThe full results of the scan.