api-screenshot

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #android #machine-learning #docker #macos #java #windows #awesome-list #vue #ios #mcp #open-source

(★ 122)

A service to add web page screenshots to your Eleventy sites.

파일 탐색기

최종 버전 다운로드 (.zip)

- screenshot.js
- sample.js
.gitignore
404.html
package.json
README.md
robots.txt
screenshot-options.js
screenshot.js
vercel.json

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Screenshot API

A runtime service to use live website screenshots on your site.

Read the [Blog post: Building an Automated Screenshot Service on Netlify in ~140 Lines of Code](https://www.zachleat.com/web/screenshots/).

## Usage

Image URLs have the formats:

```
/:url/
/:url/:size/
/:url/:size/x.jpg
/:url/:size/:aspectratio/
/:url/:size/:aspectratio/:zoom/
```

* `url` must be URI encoded.
* Valid `size` values:
  * `small`: 375×___ (default)
  * `medium`: 650×___
  * `large`: 1024×___
    * `aspectratio` of `9:16` is not supported (throws an error)
  * `opengraph`: always 1200×630, works with `zoom`
    * `aspectratio` is ignored (no errors thrown)
* Valid `aspectratio` values:
  * `1:1` (default)
  * `9:16`
* Valid `zoom` values:
  * `bigger` (1.4 `devicePixelRatio`)
  * `smaller` (0.71 `devicePixelRatio`)

### Advanced Options

#### Custom Wait Conditions

You can customize the conditions with which the headless browser will wait to take the screenshot. At a low level, this controls the [`waitUntil` property in Puppeteer’s `goto` call](https://pptr.dev/#?product=Puppeteer&version=v13.3.1&show=api-pagegotourl-options). The options are:

* DOMContentLoaded `wait:0`
* Load event `wait:1` (default)
* Load event and there have been no network connections for 500ms: `wait:2`
* Load event and there are fewer than two network connections for 500ms: `wait:3`

```
/:url/_wait:0/
/:url/_wait:1/
/:url/_wait:2/
/:url/_wait:3/
```

#### Custom Timeout

Number of seconds to wait before the request times out. We will attempt to simulate the stop button and return the screenshot that exists up to that point. Worst case, a default Eleventy logo is returned.

* Minimum: `3`
* Maximum: `9`

```
/:url/_timeout:3/
/:url/_timeout:9/
```

#### Combine these options

You can use any of these advanced options together, like `/:url/_wait:0_timeout:2/`. Order only matters to the uniqueness of the URL caching on the CDN: `/:url/_wait:0/` and `/:url/_wait:0/` will be functionally equivalent but make two different screenshot requests.

api-screenshot

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

api-screenshot

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README