Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.95 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.95 KB

parcel-plugin-metaimage

Set absolute URL for og:image and twitter:image meta tags.

npm

This plugin is based on Luke Childs and nothingrandom code.

Sets absolute URLs for og:image of twitter:image meta tags. This is required by the spec and relative URLs will not work on some sites such as Facebook or Twitter.

You can fix this directly in parcel by using --public-url https://example.com, however now all your URLs are hardcoded to absolute URLs which may be undesirable and can break things like prerendering.

This plugin uses the value of the og:url meta tag to convert og:image to an absolute URL.

Install

npm install parcel-plugin-metaimage

Usage

Just install this package as a development dependency. Parcel will automatically call it when building your application.

You must have both og:image and og:url meta tags:

<meta name="twitter:image" content="card.png">
<meta property="og:image" content="card.png">
<meta property="og:url" content="https://example.com">

Parcel will generate that into something like this:

<meta name="twitter:image" content="/card.9190ce93.png">
<meta property="og:image" content="/card.9190ce93.png">
<meta property="og:url" content="https://example.com">

parcel-plugin-ogimage will then update the og:image and twitter:image with an absolute URL:

<meta name="twitter:image" content="https://example.com/card.9190ce93.png">
<meta property="og:image" content="https://example.com/card.9190ce93.png">
<meta property="og:url" content="https://example.com">

License

MIT @ Eliepse

From Luke Childs and nothingrandom code