root
/
playwright
mirror of https://github.com/microsoft/playwright.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity
playwright/utils/doclint
History
Pavel Feldman 761b78efc0
docs: generate links based on the method names (#4593) 		2020-12-04 09:03:33 -08:00
..
check_public_api feat(websocket): implement Web Sockets for Chromium & WebKit (#4234) 2020-10-26 22:20:43 -07:00
preprocessor docs: generate links based on the method names (#4593) 2020-12-04 09:03:33 -08:00
.gitignore
…
Message.js
…
README.md
…
Source.js docs: generate method signatures in docs (#4590) 2020-12-03 22:28:11 -08:00
cli.js docs: generate links based on the method names (#4593) 2020-12-04 09:03:33 -08:00
generateApiJson.js fix(api.json): use separate maps for methods and events (#4310) 2020-11-02 18:31:32 -08:00

README.md

DocLint

Doclint is a small program that lints Playwright's documentation against Playwright'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 playwright 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