Difference between revisions of "Extensions:Screenshot Meta Tag Images"
Jump to navigation
Jump to search
(Created page with "{{subst:Extension Page}}") Tag: 2017 source edit |
Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
| − | {{Extensioninfobox|title= | + | {{Extensioninfobox|title=Screenshot Meta Tag Images|desc=Adds support for page screenshots as meta tag images.|auth=Mercury|status=Stable|github={{Github|user=itinerare|branch=screenshot-meta-img}}|migration=no|package=no}} |
<!-- Put a short summary of your extension here! --> | <!-- Put a short summary of your extension here! --> | ||
| + | Adds support for screenshots as the meta tag/preview image (on twitter, discord, etc.) captured from the page as viewed at the time. This is accomplished via use of the [https://www.thum.io thumb.io] API; note that while up to 1000 screenshots are available per month free, beyond this requires a paid account. However, this service was selected in particular due to being fairly lenient in its free limit and affordable beyond that. | ||
== Installation == | == Installation == | ||
<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | <!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | ||
| + | # Sign up for a [https://www.thum.io thumb.io] account. Make a key; this can be called whatever you want. | ||
| + | # On the dashboard, click "keys", then "more info" next to the key you made. Click "Edit key" at the bottom of the page. | ||
| + | # Set "Type" to "MD5". Click "Save". | ||
| + | # Record the '''ID''' and '''Secret Key''' displayed. | ||
| + | # Add the following values to your .env file: | ||
| + | <code>THUMB_IO_ID=your_id_here | ||
| + | THUMB_IO_KEY=your_secret_key_here</code> | ||
| + | # Pull the branch. | ||
== Configuration == | == Configuration == | ||
<!-- Is any configuration necessary? Describe it here! --> | <!-- Is any configuration necessary? Describe it here! --> | ||
| + | None required. | ||
== Usage == | == Usage == | ||
<!-- Is there anything users should know about using your extension? --> | <!-- Is there anything users should know about using your extension? --> | ||
| + | Screenshot images should display with the rest of the meta tag information automatically (for pages without specifically set preview images) when a page on the site is linked. | ||
== Troubleshooting == | == Troubleshooting == | ||
<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? --> | <!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? --> | ||
| + | Find me in the Lorekeeper server! | ||
== See Also == | == See Also == | ||
<!-- Any relevant other pages. You may consider linking to related extensions, for instance. --> | <!-- Any relevant other pages. You may consider linking to related extensions, for instance. --> | ||
| − | |||
Revision as of 19:32, 10 March 2021
| Description | Adds support for page screenshots as meta tag images. |
|---|---|
| Author(s) | Mercury |
| Status | Stable |
| Github | screenshot-meta-img |
| LK Version | Unspecified |
Adds support for screenshots as the meta tag/preview image (on twitter, discord, etc.) captured from the page as viewed at the time. This is accomplished via use of the thumb.io API; note that while up to 1000 screenshots are available per month free, beyond this requires a paid account. However, this service was selected in particular due to being fairly lenient in its free limit and affordable beyond that.
Installation
- Sign up for a thumb.io account. Make a key; this can be called whatever you want.
- On the dashboard, click "keys", then "more info" next to the key you made. Click "Edit key" at the bottom of the page.
- Set "Type" to "MD5". Click "Save".
- Record the ID and Secret Key displayed.
- Add the following values to your .env file:
THUMB_IO_ID=your_id_here
THUMB_IO_KEY=your_secret_key_here
- Pull the branch.
Configuration
None required.
Usage
Screenshot images should display with the rest of the meta tag information automatically (for pages without specifically set preview images) when a page on the site is linked.
Troubleshooting
Find me in the Lorekeeper server!
