denverprophitjr / github-action-screenshots

📸 GitHub action to generate screenshots

Styled screenshots

GitHub Action to generate styled screenshots

Table of contents

• Styled screenshots
  • Table of contents
  • Description
  • Inputs
    • url
    • name
    • path
    • extension
    • encoding
    • fullPage
    • width
    • height
  • Outputs
    • image
  • Examples
  • Visitor stats
  • Licensing
  • Authors
  • Versioning
  • Contribution
  • Acknowledgement
  • Forks
  • Development Support

Description

Creates screenshots by input json data source and dimension parameters.

Inputs

url

Required Target url to create a screenshot from.

name

Optional Screenshot image name (default screenshot)

path

Optional Screenshot image path (default images)

extension

Optional Screenshot image extension (default png)

encoding

Optional Screenshot image encoding (default binary)

fullPage

Optional Screenshot image with a full-page view (default false)

width

Optional Screenshot image width (default 1024)

height

Optional Screenshot image height (default 768)

Outputs

image

Generated screenshot image (stored in the path directory)

Examples

- name: Create screenshots
  uses: alexrogalskiy/github-action-screenshots@master
  with:
    url: 'https://www.google.com/'
    name: 'screenshot'
    path: 'images'
    extension: 'png'
    encoding: 'binary'
    fullPage: false
    width: 400
    height: 400

Running locally:

• npm run start:action --action github-action-screenshots --url 'https://www.google.com/' --name screenshot-name --extension png --width 400 --height 400

Visitor stats

Licensing

Styled Screenshots is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.

Authors

Styled Screenshots is maintained by the following GitHub team-members:

• 

with community support please contact with us if you have some question or proposition.

Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

Contribution

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).

This project follows the all-contributors specification. Contributions of any kind are welcome!

See also the list of contributors who participated in this project.

Acknowledgement

Forks

Development Support

Like Styled Screenshots ? Consider buying me a coffee :)

---