Low-code documentation testing embedded in your project via NPM.

For pre-built implementations, see Doc Detective.

npm i doc-detective-core

const { runTests, runCoverage } = require("doc-detective-core");

Run test specifications. Returns a test report object. Takes config as input. Parses paths in the config.input for test specifications to perform.

Looking to help out? See our contributions guide for more info. If you can't contribute code, you can still help by reporting issues, suggesting new features, improving the documentation, or sponsoring the project.