Comments (3)
Others on my team put together: https://googlechrome.github.io/npm-publish-scripts/travis-to-github-pages.html#main. Example api page that uses it: https://googlechrome.github.io/sw-toolbox/api.html#main
I've never used it myself. Looks like the md files are still manually maintained: https://github.com/GoogleChrome/sw-toolbox/tree/master/docs
from puppeteer.
With the latest change, it's not scary any more to edit api.md
manually. So there's no point in generating it any more.
However, the doc is getting outdated pretty fast. So the issue should be about linting api.md
and making sure it is up-to-date (at least to some extend).
from puppeteer.
Now there's a doclint utility which lints codebase against markdown's api.md
documentation. doclint is a part of npm run lint
command. It could be also run separately via the npm run doc
command.
The utility makes sure that the following entities in documentation are aligned with codebase:
- classes
- methods, method arguments and method return statements
- public properties, such as browser.stderr
- events, such as Page's 'dialog' event
- proper sorting of class members (events first, then constructor, then all the other members)
doclint doesn't generate any markup, it instead complains when it finds a mismatch.
doclint messages might be confusing at times and there should be some bugs - feel free to complain. We'll smooth it out over time.
I think this implements all the necessary features for the documentation linting.
from puppeteer.
Related Issues (20)
- [Bug] puppeteer.launch with cmd file cause spawn EINVAL with recent node security patch HOT 7
- [Bug]: emoji font not displayed (just blank spaces) HOT 42
- [Bug]: `PerformanceNavigationTiming.type` is `navigation` after pressing back button HOT 7
- [Bug]: Error: net::ERR_FAILED HOT 2
- [Feature]: Let docker/Dockerfile use node:20-slim as the base image HOT 2
- [Bug]: #<NoSuchFrameException> occurs even when manually navigating to a page while the browser is idle in puppeteer HOT 2
- [Bug]: Error: Could not find Chrome (ver. 124.0.6367.78). HOT 2
- [Bug]: Instructions can be improved/corrected HOT 2
- Switch to macos-latest (arm64) in ci
- [Feature]: Request Initiator Chain HOT 8
- [Bug]: Could not find Chrome (ver. ${this.puppeteer.browserRevision}) on Docker HOT 7
- [Bug]: 'page.waitForTimeout' not working in Puppeteer 22.7.1 HOT 2
- [Bug]: use manifest V3 .When the file(manifest.json) carries ”content_scripts“,puppeteer.launch timeout HOT 16
- "[network.spec] network Request.resourceType should work for document type" is flaky in firefox
- ignoreHttpsErrors should be renamed to acceptInsecureCerts
- [Bug]: Redirect stops before the final destination that has an error Name Not Resolved HOT 4
- Node process is hanging after all bidi tests are finished HOT 1
- AWS lambda: running puppeteer-core 21.5.2 and @sparticuz/chromium 118.0.0 on node 18 runtime failes ONLY when my html (for PDF rendering) contains https HOT 1
- [Bug]: the parameter outline in page.pdf seems not work HOT 6
- [Bug]: PDF page numbers no longer working in headless: shell HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from puppeteer.