README.md

← Back to plugins index
📸 Website screenshot
This plugin displays a screenshot from any website. It can either show the full page or a portion restricted by a CSS selector.
Authors	@lowlighter
Supported features → Full specification	📗 Classic template 📘 Repository template 📙 Terminal template
	👤 Users 👥 Organizations 📓 Repositories
	No tokens are required for this plugin

➡️ Available options

Option	Description
plugin_screenshot	Enable screenshot plugin
🌐 Web instances must configure settings.json: metrics.run.puppeteer.scrapping type: boolean default: no
plugin_screenshot_title	Title caption
type: string default: Screenshot
plugin_screenshot_url	Website URL
type: string
plugin_screenshot_selector	CSS Selector
type: string default: body
plugin_screenshot_mode	Output mode image: screenshot of selected element text: keep innerText of selected element ⚠️ Any CSS style applied to text such as font size, weight or color will be removed
type: string default: image allowed values: image text
plugin_screenshot_viewport	Viewport options
type: json default: → Click to expand { "width": 1280, "height": 1280 }
plugin_screenshot_wait	Wait time before taking screenshot (ms)
type: number (0 ≤ 𝑥) default: 0
plugin_screenshot_background	Background
type: boolean default: yes

ℹ️ Examples workflows

name: XKCD of the day
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.screenshot.svg
  token: NOT_NEEDED
  base: ""
  plugin_screenshot: yes
  plugin_screenshot_title: XKCD of the day
  plugin_screenshot_url: https://xkcd.com
  plugin_screenshot_selector: "#comic img"