linkinator.config.json

Linkinator config file

linkinator.config.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your linkinator.config.json and it validates in your browser — nothing is uploaded.

Validate a linkinator.config.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`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 default: `true`
`skip`	`oneOf`	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"` one of: `"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`	`oneOf`	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
`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.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
16 properties, 100% carrying a description, max nesting depth 6.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`format`	JSON Schema Validation, draft 2020-12	§7 — Vocabularies for Semantic Content With "format"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas