History

Andrey Lushnikov 0adffcc2cb docs: add table-of-contents to troubleshooting (#4234 ) Drive-by: teach our table-of-contents generator to ignore comments inside fenced blocks and to de-linkify titles.		2019-04-02 19:08:22 -07:00
..
check_public_api	chore(types): generate our own d.ts file from api.md (#3744 )	2019-01-28 15:12:45 -08:00
generate_types	fix(types): don't report events as class members (#3874 )	2019-01-31 17:53:16 -08:00
preprocessor	docs: add table-of-contents to troubleshooting (#4234 )	2019-04-02 19:08:22 -07:00
.gitignore	[doclint] move doclint testing to golden	2017-07-13 11:17:02 -07:00
cli.js	docs: add table-of-contents to troubleshooting (#4234 )	2019-04-02 19:08:22 -07:00
Message.js	[doclint] Prepare doclint for more checks	2017-07-31 00:10:59 -07:00
README.md	[doclint] Move doclint under utils/	2017-07-13 00:28:52 -07:00
Source.js	chore(doclint): remove SourceFactory (#2447 )	2018-04-25 18:07:20 -07:00

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

Doclint has its own set of jasmine tests, located at utils/doclint/test folder.

To execute tests, run:

npm run test-doclint