Docaudit

Audit documentation code coverage.

To install Docaudit:

npm install --global docaudit

And to audit a file:

docaudit README.md

Docaudit will scan the directory for .MD or .MDX files and check the content of each file for two attributes:

• Any headings that are marked as code spans
• A code block containing npm install OR the title of the document

With that information, Docaudit will download the npm package identified in the markdown file and scan the package exports. If an export has a corresponding heading in the markdown file, Docaudit will mark the export as documented (aka "yes"). If not, it will mark the export as undocumented (aka "no").

Docaudit logs a summary of findings to the console and saves a timestamped report as JSON in the directory.

Commands

docaudit

docaudit [<filePath> | <folderPath>]

Audit a file or folder. By default, Docaudit will scan the folder where it is executed. If it receives a <filePath>, it will only audit the specified file. If it receives a <folderPath>, it will audit the contents of that folder.