https://github.com/stared/screenshot
From https://simonwillison.net/2022/Mar/14/shot-scraper-template/
https://github.com/stared/screenshot
Last synced: 4 months ago
JSON representation
From https://simonwillison.net/2022/Mar/14/shot-scraper-template/
- Host: GitHub
- URL: https://github.com/stared/screenshot
- Owner: stared
- Created: 2022-03-15T09:32:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-15T14:16:20.000Z (over 3 years ago)
- Last Synced: 2025-01-13T19:56:49.802Z (6 months ago)
- Size: 817 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# shot-scraper-template
Quickly create a new GitHub repository that takes automated screenshots of a web page using [shot-scraper](https://github.com/simonw/shot-scraper).
Read more about how this works in [Instantly create a GitHub repository to take screenshots of a web page](https://simonwillison.net/2022/Mar/14/shot-scraper-template/).
[simonw/simonwillison-net-shot](https://github.com/simonw/simonwillison-net-shot) is an example repository created using this template.
## How to get started
Visit https://github.com/simonw/shot-scraper-template/generate
Pick a name for your new repository, and paste **the URL** of the page you would like to take screenshots of into the **description field** (including the `http://` or `https://`).
Then click **Create repository from template**.
Your new repository will be created, and a script will run which will do the following:
- Add a `shots.yml` file to your repository containing the URL of the page you requested
- Take a screenshot of that URL and add that to you repository as a file called `shot.png`
You can then edit that `shots.yml` file to customize your screenshot, or add more URLs - see below.
## Re-taking the screenshot
To re-take the screenshot:
- Click "Actions"
- Select the "Take screenshots" workflow
- Click the "Run workflow" menu item
- Click the green "Run workflow" button
The repository will keep a history of every previous version of each screenshot, which is useful for keeping track of visual changes to a page.
## Configuring the screenshots
The initial `shots.yml` file in your repository should look like this:
```yaml
- url: https://simonwillison.net/
output: shot.png
height: 800
```
To change the name of the file that the screenshot is saved to, change `output: shot.png` to a different file name.
To take a full height image of the page, remove the `height: 800` line.
To add additional screenshots, add them to the YAML file like this:
```yaml
- url: https://simonwillison.net/
output: shot.png
height: 800
- url: https://www.example.com/
output: example.png
height: 800
```
Further options are described in the [shot-scraper README file](https://github.com/simonw/shot-scraper#taking-multiple-screenshots).