From cb1c8d204e38996b6a44dc5b4071d5782d4dfe68 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Sat, 15 Jan 2022 20:18:01 -0500 Subject: [PATCH] doc(plugins/screenshot): update --- source/plugins/screenshot/README.md | 49 ++++++++++++++++---------- source/plugins/screenshot/metadata.yml | 20 +++++------ 2 files changed, 40 insertions(+), 29 deletions(-) diff --git a/source/plugins/screenshot/README.md b/source/plugins/screenshot/README.md index 579770b3..282817b1 100644 --- a/source/plugins/screenshot/README.md +++ b/source/plugins/screenshot/README.md @@ -1,16 +1,29 @@ -### 📸 Website screenshot - -The *screenshot* plugin lets you take a screenshot from any website. -It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) or you can take a full page. - + - + + + + + + + + + + + + + + +
- - -

📸 Website screenshot

This plugin display a screenshot from any website. +It can either the full page or a portion restricted by a CSS selector.

+
Supported features
→ Full specification
📗 Classic template 📘 Repository template 📙 Terminal template
👤 Users đŸ‘Ĩ Organizations 📓 Repositories
No tokens are required for this plugin
+ + +
+ -#### âžĄī¸ Available options +## âžĄī¸ Available options @@ -19,7 +32,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d - @@ -29,7 +42,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d - @@ -39,7 +52,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d - @@ -48,7 +61,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d - @@ -58,7 +71,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d - @@ -69,9 +82,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
plugin_screenshot

Display a screenshot of any website

+

Enable screenshot plugin

plugin_screenshot_title

Screenshot title caption

+

Title caption

plugin_screenshot_url

Website to take screenshot

+

Website url

plugin_screenshot_selector

Selector to take in screenshot

+

CSS Selector

plugin_screenshot_background

Display or remove default page background

+

Display background

-*[→ Full specification](metadata.yml)* - -#### â„šī¸ Examples workflows +## â„šī¸ Examples workflows ```yaml @@ -87,4 +98,4 @@ with: plugin_screenshot_selector: '#comic img' ``` - \ No newline at end of file + diff --git a/source/plugins/screenshot/metadata.yml b/source/plugins/screenshot/metadata.yml index 67cee194..907aa565 100644 --- a/source/plugins/screenshot/metadata.yml +++ b/source/plugins/screenshot/metadata.yml @@ -1,5 +1,10 @@ name: "📸 Website screenshot" category: community +description: | + This plugin display a screenshot from any website. + It can either the full page or a portion restricted by a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors). +examples: + default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg authors: - lowlighter supports: @@ -9,33 +14,28 @@ supports: scopes: [] inputs: - # Enable or disable plugin plugin_screenshot: - description: Display a screenshot of any website + description: Enable screenshot plugin type: boolean default: no - # Screenshot title caption plugin_screenshot_title: - description: Screenshot title caption + description: Title caption type: string default: Screenshot - # Website to take screenshot plugin_screenshot_url: - description: Website to take screenshot + description: Website url type: string default: "" example: https://metrics.lecoq.io - # Selector to take in screenshot plugin_screenshot_selector: - description: Selector to take in screenshot + description: CSS Selector type: string default: body - # Display or remove default page background plugin_screenshot_background: - description: Display or remove default page background + description: Display background type: boolean default: yes \ No newline at end of file