Skip to content

Commit cb1c8d2

Browse files
committed
doc(plugins/screenshot): update
1 parent a077e5d commit cb1c8d2

File tree

2 files changed

+40
-29
lines changed

2 files changed

+40
-29
lines changed
Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
1-
### 📸 Website screenshot
2-
3-
The *screenshot* plugin lets you take a screenshot from any website.
4-
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.
5-
1+
<!--header-->
62
<table>
7-
<td align="center">
8-
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg">
9-
<img width="900" height="1" alt="">
10-
</td>
3+
<tr><th colspan="2"><h3>📸 Website screenshot</h3></th></tr>
4+
<tr><td colspan="2" align="center"><p>This plugin display a screenshot from any website.
5+
It can either the full page or a portion restricted by a <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors">CSS selector</a>.</p>
6+
</td></tr>
7+
<tr>
8+
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
9+
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a> <a href="/source/templates/terminal"><code>📙 Terminal template</code></a></td>
10+
</tr>
11+
<tr>
12+
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
13+
</tr>
14+
<tr>
15+
<td><i>No tokens are required for this plugin</i></td>
16+
</tr>
17+
<tr>
18+
<td colspan="2" align="center">
19+
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg" alt=""></img>
20+
<img width="900" height="1" alt="">
21+
</td>
22+
</tr>
1123
</table>
24+
<!--/header-->
1225

13-
#### ➡️ Available options
26+
## ➡️ Available options
1427

1528
<!--options-->
1629
<table>
@@ -19,7 +32,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
1932
</tr>
2033
<tr>
2134
<td nowrap="nowrap"><code>plugin_screenshot</code></td>
22-
<td rowspan="2"><p>Display a screenshot of any website</p>
35+
<td rowspan="2"><p>Enable screenshot plugin</p>
2336
<img width="900" height="1" alt=""></td>
2437
</tr>
2538
<tr>
@@ -29,7 +42,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
2942
</tr>
3043
<tr>
3144
<td nowrap="nowrap"><code>plugin_screenshot_title</code></td>
32-
<td rowspan="2"><p>Screenshot title caption</p>
45+
<td rowspan="2"><p>Title caption</p>
3346
<img width="900" height="1" alt=""></td>
3447
</tr>
3548
<tr>
@@ -39,7 +52,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
3952
</tr>
4053
<tr>
4154
<td nowrap="nowrap"><code>plugin_screenshot_url</code></td>
42-
<td rowspan="2"><p>Website to take screenshot</p>
55+
<td rowspan="2"><p>Website url</p>
4356
<img width="900" height="1" alt=""></td>
4457
</tr>
4558
<tr>
@@ -48,7 +61,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
4861
</tr>
4962
<tr>
5063
<td nowrap="nowrap"><code>plugin_screenshot_selector</code></td>
51-
<td rowspan="2"><p>Selector to take in screenshot</p>
64+
<td rowspan="2"><p>CSS Selector</p>
5265
<img width="900" height="1" alt=""></td>
5366
</tr>
5467
<tr>
@@ -58,7 +71,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
5871
</tr>
5972
<tr>
6073
<td nowrap="nowrap"><code>plugin_screenshot_background</code></td>
61-
<td rowspan="2"><p>Display or remove default page background</p>
74+
<td rowspan="2"><p>Display background</p>
6275
<img width="900" height="1" alt=""></td>
6376
</tr>
6477
<tr>
@@ -69,9 +82,7 @@ It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/d
6982
</table>
7083
<!--/options-->
7184

72-
*[→ Full specification](metadata.yml)*
73-
74-
#### ℹ️ Examples workflows
85+
## ℹ️ Examples workflows
7586

7687
<!--examples-->
7788
```yaml
@@ -87,4 +98,4 @@ with:
8798
plugin_screenshot_selector: '#comic img'
8899

89100
```
90-
<!--/examples-->
101+
<!--/examples-->
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
name: "📸 Website screenshot"
22
category: community
3+
description: |
4+
This plugin display a screenshot from any website.
5+
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).
6+
examples:
7+
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.screenshot.svg
38
authors:
49
- lowlighter
510
supports:
@@ -9,33 +14,28 @@ supports:
914
scopes: []
1015
inputs:
1116

12-
# Enable or disable plugin
1317
plugin_screenshot:
14-
description: Display a screenshot of any website
18+
description: Enable screenshot plugin
1519
type: boolean
1620
default: no
1721

18-
# Screenshot title caption
1922
plugin_screenshot_title:
20-
description: Screenshot title caption
23+
description: Title caption
2124
type: string
2225
default: Screenshot
2326

24-
# Website to take screenshot
2527
plugin_screenshot_url:
26-
description: Website to take screenshot
28+
description: Website url
2729
type: string
2830
default: ""
2931
example: https://metrics.lecoq.io
3032

31-
# Selector to take in screenshot
3233
plugin_screenshot_selector:
33-
description: Selector to take in screenshot
34+
description: CSS Selector
3435
type: string
3536
default: body
3637

37-
# Display or remove default page background
3838
plugin_screenshot_background:
39-
description: Display or remove default page background
39+
description: Display background
4040
type: boolean
4141
default: yes

0 commit comments

Comments
 (0)