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
6d19db4df1
puppeteer/utils/doclint
History
Andrey Lushnikov 6d19db4df1
chore: enhance preprocessor commands to automate releases. (#2446) 
Last release v1.3.0 had an error in the documentation, claiming
it wasn't released.

This patch makes sure we have a little bit of automation in place
to save us from this in future.
2018-04-25 17:11:45 -07:00
..
check_public_api chore(types): upgrade to TypeScript 2.8.1 (#2304) 2018-04-04 14:06:21 -07:00
preprocessor chore: enhance preprocessor commands to automate releases. (#2446) 2018-04-25 17:11:45 -07:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
cli.js chore: enhance preprocessor commands to automate releases. (#2446) 2018-04-25 17:11:45 -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
SourceFactory.js [doclint] Implement simple markdown preprocessor 2017-07-31 02:06:27 -07:00
toc.js Change let into const (#457) 2017-08-21 16:39:04 -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