Files
metrics/source/plugins/screenshot/README.md

1.6 KiB
Raw Blame History

📸 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

Option Type (format) [default] {allowed values} Description
plugin_screenshot boolean [no] Display a screenshot of any website
plugin_screenshot_title string [Screenshot] Screenshot title caption
plugin_screenshot_url string [] Website to take screenshot
plugin_screenshot_selector string [body] Selector to take in screenshot
plugin_screenshot_background boolean [yes] Display or remove default page background

Legend for option icons:

  • 🔐 Value should be stored in repository secrets
  • New feature currently in testing on master/main

→ 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'