thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add readme to the API reference index (#10001)

Browse Source
This commit is contained in:
Alex Rudenko 2023-04-11 14:47:25 +02:00 committed by GitHub
parent 1eca5663f1
commit dba1b2d9cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/browsers-api/index.md
View File

@ -2,7 +2,34 @@
sidebar_label: API
---
# API Reference
# @puppeteer/browsers
Manage and launch browsers/drivers from a CLI or programmatically.
## CLI
Use `npx` to run the CLI:
```sh
npx @puppeteer/browsers --help
```
CLI help will provide all documentation you need to use the CLI.
```sh
npx @puppeteer/browsers --help # help for all commands
npx @puppeteer/browsers install --help # help for the install command
npx @puppeteer/browsers launch --help # help for the launch command
```
## Known limitations
1. We support installing and running Firefox and Chrome/Chromium. The `latest` keyword only works during the installation. For the `launch` command you need to specify an exact build ID. The build ID is provided by the `install` command (see `npx @puppeteer/browsers install --help` for the format).
2. Launching the system browsers is only possible for Chrome/Chromium.
## API
The programmatic API allows installing and launching browsers from your code. See the `test` folder for examples on how to use the `install`, `canInstall`, `launch`, `computeExecutablePath`, `computeSystemExecutablePath` and other methods.
## Classes

20
packages/browsers/README.md
View File

@ -4,26 +4,12 @@ Manage and launch browsers/drivers from a CLI or programmatically.
## CLI
Use `npx` to run the CLI without installing:
Use `npx` to run the CLI:
```sh
npx @puppeteer/browsers --help
```
or install the package as a dependency and run it from your `package.json` script:
```sh
npm i @puppeteer/browsers
```
```json
{
"scripts": {
"browsers": "@puppeteer/browsers --help"
}
}
```
CLI help will provide all documentation you need to use the CLI.
```sh
@ -32,9 +18,9 @@ npx @puppeteer/browsers install --help # help for the install command
npx @puppeteer/browsers launch --help # help for the launch command
```
Known limitations:
## Known limitations
1. We support installing and running Firefox and Chrome/Chromium. The `latest` keyword only works during the installation. For the `launch` command you need to specify an exact build ID. The build ID is provided by the `install` command.
1. We support installing and running Firefox and Chrome/Chromium. The `latest` keyword only works during the installation. For the `launch` command you need to specify an exact build ID. The build ID is provided by the `install` command (see `npx @puppeteer/browsers install --help` for the format).
2. Launching the system browsers is only possible for Chrome/Chromium.
## API

11
tools/generate_docs.ts
View File

@ -119,7 +119,7 @@ function spliceIntoSection(
.outputs(['docs/api'])
.build();
job('', async ({inputs, outputs}) => {
await job('', async ({inputs, outputs}) => {
await rm(outputs[0]!, {recursive: true, force: true});
generateDocs(inputs[0]!, outputs[0]!);
spawnAndLog('prettier', '--ignore-path', 'none', '--write', 'docs');
@ -130,4 +130,13 @@ function spliceIntoSection(
])
.outputs(['docs/browsers-api'])
.build();
job('', async ({inputs, outputs}) => {
const readme = await readFile(inputs[1]!, 'utf-8');
const index = await readFile(inputs[0]!, 'utf-8');
await writeFile(outputs[0]!, index.replace('# API Reference\n', readme));
})
.inputs(['docs/browsers-api/index.md', 'packages/browsers/README.md'])
.outputs(['docs/browsers-api/index.md'])
.build();
})();