step-security/Linkinator

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

Trust Signals

name	description	required	default
paths	Paths to scan for 404s. Defaults to *.md.	no	*.md
concurrency	The number of connections to make simultaneously.	no	100
recurse	Recursively follow links on the same root domain.	no	false
linksToSkip	List of urls in regexy form to not include in the check.	no	—
skip	List of urls in regexy form to not include in the check.	no	—
timeout	Request timeout in ms. Defaults to 0 (no timeout).	no	0
markdown	Automatically parse and scan markdown if scanning from a location on disk.	no	true
serverRoot	When scanning a locally directory, customize the location on disk where the server is started.	no	—
directoryListing	Include an automatic directory index file when linking to a directory.	no	false
retry	Automatically retry requests that return HTTP 429 responses and include a "retry-after" header.	no	false
verbosity	Override the default verbosity for this command. Available options are "DEBUG", "INFO", "WARNING", "ERROR", and "NONE". Defaults to "WARNING".	no	WARNING
config	Path to a config file to use. Looks for `linkinator.config.json` by default. Options defined via the GitHub Action config will take precedence.	no	—
urlRewriteSearch	Pattern to search for in urls. Must be used with `urlRewriteReplace`.	no	—
urlRewriteReplace	Expression used to replace search content. Must be used with `urlRewriteSearch`.	no	—

name	description
results	The full results of the scan.