linkinator.config.json

Linkinator config file

Type object
File match linkinator.config.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/linkinator-config-json/latest.json
Source https://www.schemastore.org/linkinator-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

concurrency number

The number of connections to make simultaneously.

Default: 100
config string

The config file path.

recurse boolean

By default, all scans are shallow. Only the top level links on the requested page will be scanned. By setting recurse to true, the crawler will follow all links on the page, and continue scanning links on the same domain for as long as it can go. Results are cached, so no worries about loops.

Default: true
skip string | string[]

List of urls in regexy form to not include in the check.

Default: "www.googleapis.com"
format string

Return the data in CSV or JSON format.

Default: "json"
Values: "json" "text" "csv"
silent boolean

If true, does not show links

Default: false
verbosity string

The output verbosity

Default: "error"
timeout number

By default, requests made by linkinator do not time out (or follow the settings of the OS). This option (in milliseconds) will fail requests after the configured amount of time.

Default: "5000"
markdown boolean

Automatically parse and scan markdown if scanning from a location on disk.

Default: false
serverRoot string

When scanning a locally directory, customize the location on disk where the server is started. Defaults to the path passed in path.

Default: "./"
directoryListing boolean

Automatically serve a static file listing page when serving a directory. Defaults to false.

Default: false
retry boolean | object

Automatically retry requests that respond with an HTTP 429, and include a retry-after header. The RetryConfig option is a placeholder for fine-grained controls to be implemented at a later time, and is only included here to signal forward-compatibility.

retryErrors boolean

Automatically retry requests that return 5xx or unknown response.

retryErrorsCount number

How many times should an error be retried?

retryErrorsJitter number

Random jitter applied to error retry.

urlRewriteExpressions array

Collection of objects that contain a search pattern, and replacement.