Skip to content

Commit

Permalink
docs: setup redirects and fix mising index.md (#12259)
Browse files Browse the repository at this point in the history
  • Loading branch information
OrKoN committed Apr 11, 2024
1 parent 958fce0 commit a66e53c
Show file tree
Hide file tree
Showing 4 changed files with 136 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Herebyfile.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/* eslint-disable import/order */

import {readFile, writeFile} from 'fs/promises';
import {copyFile, readFile, writeFile} from 'fs/promises';

import {docgen, spliceIntoSection} from '@puppeteer/docgen';
import {execa} from 'execa';
Expand Down Expand Up @@ -71,6 +71,9 @@ export const docsTask = task({
name: 'docs',
dependencies: [docsNgSchematicsTask, docsChromiumSupportTask],
run: async () => {
// Copy main page.
await copyFile('README.md', 'docs/index.md');

// Generate documentation
for (const [name, folder] of [
['browsers', 'browsers-api'],
Expand Down
58 changes: 58 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Puppeteer

[![build](https://github.com/puppeteer/puppeteer/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/puppeteer/puppeteer/actions/workflows/ci.yml)
[![npm puppeteer package](https://img.shields.io/npm/v/puppeteer.svg)](https://npmjs.org/package/puppeteer)

<img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" height="200" align="right"/>

#### [Docs](https://pptr.dev/docs) | [API](https://pptr.dev/api) | [FAQ](https://pptr.dev/faq) | [Contributing](https://pptr.dev/contributing) | [Troubleshooting](https://pptr.dev/troubleshooting)

Puppeteer is a Node.js library which provides a high-level API to control
Chrome/Chromium over the
[DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
Puppeteer runs in
[headless](https://developer.chrome.com/docs/chromium/new-headless/)
mode by default, but can be configured to run in full ("headful")
Chrome/Chromium.

## Example

```ts
import puppeteer from 'puppeteer';

(async () => {
// Launch the browser and open a new blank page
const browser = await puppeteer.launch();
const page = await browser.newPage();

// Navigate the page to a URL
await page.goto('https://developer.chrome.com/');

// Set screen size
await page.setViewport({width: 1080, height: 1024});

// Type into search box
await page.type('.devsite-search-field', 'automate beyond recorder');

// Wait and click on first result
const searchResultSelector = '.devsite-result-item-link';
await page.waitForSelector(searchResultSelector);
await page.click(searchResultSelector);

// Locate the full title with a unique string
const textSelector = await page.waitForSelector(
'text/Customize and automate'
);
const fullTitle = await textSelector?.evaluate(el => el.textContent);

// Print the full title
console.log('The title of this blog post is "%s".', fullTitle);

await browser.close();
})();
```

## Contributing

Check out our [contributing guide](https://pptr.dev/community/contributing) to get an
overview of Puppeteer development.
16 changes: 16 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,22 @@ const config = {
from: '/chromium-support',
to: '/supported-browsers',
},
{
from: '/guides/query-selectors',
to: '/guides/page-interactions',
},
{
from: '/guides/query-selectors-legacy',
to: '/guides/page-interactions',
},
{
from: '/guides/locators',
to: '/guides/page-interactions',
},
{
from: '/guides/evaluate-javascript',
to: '/guides/javascript-execution',
},
],
}),
],
Expand Down
58 changes: 58 additions & 0 deletions website/versioned_docs/version-22.6.4/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Puppeteer

[![build](https://github.com/puppeteer/puppeteer/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/puppeteer/puppeteer/actions/workflows/ci.yml)
[![npm puppeteer package](https://img.shields.io/npm/v/puppeteer.svg)](https://npmjs.org/package/puppeteer)

<img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" height="200" align="right"/>

#### [Docs](https://pptr.dev/docs) | [API](https://pptr.dev/api) | [FAQ](https://pptr.dev/faq) | [Contributing](https://pptr.dev/contributing) | [Troubleshooting](https://pptr.dev/troubleshooting)

Puppeteer is a Node.js library which provides a high-level API to control
Chrome/Chromium over the
[DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
Puppeteer runs in
[headless](https://developer.chrome.com/docs/chromium/new-headless/)
mode by default, but can be configured to run in full ("headful")
Chrome/Chromium.

## Example

```ts
import puppeteer from 'puppeteer';

(async () => {
// Launch the browser and open a new blank page
const browser = await puppeteer.launch();
const page = await browser.newPage();

// Navigate the page to a URL
await page.goto('https://developer.chrome.com/');

// Set screen size
await page.setViewport({width: 1080, height: 1024});

// Type into search box
await page.type('.devsite-search-field', 'automate beyond recorder');

// Wait and click on first result
const searchResultSelector = '.devsite-result-item-link';
await page.waitForSelector(searchResultSelector);
await page.click(searchResultSelector);

// Locate the full title with a unique string
const textSelector = await page.waitForSelector(
'text/Customize and automate'
);
const fullTitle = await textSelector?.evaluate(el => el.textContent);

// Print the full title
console.log('The title of this blog post is "%s".', fullTitle);

await browser.close();
})();
```

## Contributing

Check out our [contributing guide](https://pptr.dev/community/contributing) to get an
overview of Puppeteer development.

0 comments on commit a66e53c

Please sign in to comment.