metrics/source/plugins/screenshot/README.md

📸 Website screenshot

The screenshot plugin lets you take a screenshot from any website. It can be restricted with a CSS selector or you can take a full page.

➡️ Available options

Type	Description
plugin_screenshot	Display a screenshot of any website
type: boolean default: no
plugin_screenshot_title	Screenshot title caption
type: string default: Screenshot
plugin_screenshot_url	Website to take screenshot
type: string
plugin_screenshot_selector	Selector to take in screenshot
type: string default: body
plugin_screenshot_background	Display or remove default page background
type: boolean default: yes

→ Full specification

ℹ️ Examples workflows

name: XKCD of the day
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.screenshot.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_screenshot: 'yes'
  plugin_screenshot_title: XKCD of the day
  plugin_screenshot_url: https://xkcd.com
  plugin_screenshot_selector: '#comic img'