c468c451c5
This patch: - move doclint testing to golden - refactor doclint/lint.js to drop specs and everything |
||
---|---|---|
.. | ||
test | ||
.gitignore | ||
Documentation.js | ||
JSBuilder.js | ||
lint.js | ||
MDBuilder.js | ||
README.md |
DocLint
Doclint is a small program that lints Puppeteer's documentation against Puppeteer's source code.
Doclint works in a few steps:
- Read sources in
lib/
folder, parse AST trees and extract public API - Read sources in
docs/
folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API - Compare one API to another
Doclint is also responsible for general markdown checks, most notably for the table of contents relevancy.
Running
npm run doc
Tests
Doclint has its own set of jasmine tests, located at utils/doclint/test
folder.
To execute tests, run:
npm run test-doclint