github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
862ad96bde
puppeteer/utils/doclint
History
Andrey Lushnikov 9904da262e
chore(doclint): remove old unused table-of-contents generator (#2659) 
We no longer use markdown-toc to generate table-of-contents.
2018-06-01 13:59:31 -07:00
..
check_public_api chore: stop using console.assert everywhere (#2646) 2018-05-31 16:53:51 -07:00
preprocessor docs(api.md): fix table-of-contents (#2636) 2018-05-31 14:21:43 -07:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
cli.js chore(doclint): remove old unused table-of-contents generator (#2659) 2018-06-01 13:59:31 -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

README.md

DocLint

Doclint is a small program that lints Puppeteer's documentation against Puppeteer's source code.

Doclint works in a few steps:

  1. Read sources in lib/ folder, parse AST trees and extract public API
  2. Read sources in docs/ folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API
  3. 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