Skip to navigation

Verification options

Options for writing verification results back into source files after a run: verified-by entries, last-verified dates, and “Last verified” badges.

Referenced In

Fields

FieldTypeDescriptionDefault
writeone of:
- boolean
- string
Optional. What Doc Detective writes back after a run. "existing" (the default) fills only the verified-by entries and badge: true tests that a page already declares. true also declares them on a passing run: a front-matter verified-by entry on each passing Markdown or MDX page, and a meta statement above each passing inline test. An inline test with no testId first gets the id Doc Detective generated for it, written into its test statement so it stays fixed. false writes nothing back. Override from the CLI with --verification.existing

Examples

{
"write": "existing"
}