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
Files
e8a085ccfb478d51cd45172dbc7f4d1311c75ec8
puppeteer/utils/doclint
History
Andrey Lushnikov e8a085ccfb feat(appMode): support pipes for appMode (#2032) 
This patch starts using pipes as a transport to
the browser instance instead of websocket.
2018-02-14 17:51:29 -08:00
..
check_public_api
feat(appMode): support pipes for appMode (#2032)
2018-02-14 17:51:29 -08:00
preprocessor
chore: Spelling and Markdown Consistency (#1998)
2018-02-08 22:59:46 -05:00
.gitignore
…
cli.js
chore(doclint): do not attempt to lint non-documentation markdown
2017-11-07 03:33:25 -08:00
Message.js
[doclint] Prepare doclint for more checks
2017-07-31 00:10:59 -07:00
README.md
…
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