eleventy-plugin-vimeo-embed

![NPM Version](https://www.npmjs.com/package/eleventy-plugin-vimeo-embed)
![Build test status](https://github.com/gfscott/eleventy-plugin-embed-everything/actions/workflows/test.yml?query=branch%3Amain)
![codecov](https://codecov.io/gh/gfscott/eleventy-plugin-embed-everything)\
![MIT License](https://github.com/gfscott/eleventy-plugin-embed-everything/blob/main/LICENSE)
![Contributor Covenant](https://github.com/gfscott/eleventy-plugin-embed-everything/blob/main/CODE_OF_CONDUCT.md)

This Eleventy plugin automatically embeds responsive Vimeo videos from URLs in Markdown files.

- ⚡️ Installation
- 🛠 Usage
- ⚙️ Settings
- ⚠️ Notes and caveats

---

⚡️ Installation

In your Eleventy project, install the plugin through npm:

``sh $ npm i eleventy-plugin-vimeo-embed`

Then add it to your Eleventy config file:

`javascript const embedVimeo = require("eleventy-plugin-vimeo-embed");

module.exports = function(eleventyConfig) { eleventyConfig.addPlugin(embedVimeo); };`

`🛠 Usage`

To embed a Vimeo video into any Markdown page, paste its URL into a new line. The URL should be the only thing on that line.

`$3`

`markdown Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam vehicula, elit vel condimentum porta, purus.

https://vimeo.com/347565673

Maecenas non velit nibh. Aenean eu justo et odio commodo ornare. In scelerisque sapien at.`

`$3`

!Screenshot of a Vimeo embed of Christian Stangl’s “The Comet”

`⚙️ Settings`

You can configure the plugin to change its behavior by passing an options object to the addPlugin function:

`javascript eleventyConfig.addPlugin(embedVimeo, { // edit options here });`

`$3`

Edit any of the default values in this options object to override the plugin behavior. These are the default settings, which will apply to all embed instances. Currently there’s no way to configure individual embeds.

`javascript { // Default “allowfullscreen” boolean attribute that gets applied to the embed .<br /> // Change to false to disable fullscreen.<br /> allowFullscreen: true,<br /> // Default “dnt” (“do-not-track”) boolean attribute that gets applied to the embed URL.<br /> // Change to false to allow cookies and other tracking technology.<br /> dnt: true,<br /> // Default class that gets applied to the wrapper <div>.<br /> // Substitute your preferred string to target embeds with CSS.<br /> embedClass: 'eleventy-plugin-vimeo-embed'<br />});<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3">The plugin supports common Vimeo URL variants as well, including <a href="https://help.vimeo.com/hc/en-us/articles/12426199699985-About-video-privacy-settings" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">unlisted videos</a> available on paid plans. These should also work in your Markdown files:</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">markdown<br /></p><p class="my-3">vimeo.com/347565673<br />www.vimeo.com/347565673</p><p class="my-3"></p><p class="my-3">http://vimeo.com/347565673<br />https://vimeo.com/347565673</p><p class="my-3"></p><p class="my-3">https://www.vimeo.com/347565673<br />https://vimeo.com/347565673</p><p class="my-3"></p><p class="my-3">https://vimeo.com/347565673?autoplay=1<br />https://vimeo.com/347565673#t30s<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">If you run across a URL pattern that you think should work, but doesn’t, please <a href="https://github.com/gfscott/eleventy-plugin-embed-everything/issues/new" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">file an issue</a>!</p><p class="my-3"><h2 class="text-xl font-semibold mt-5 mb-3">⚠️ Notes and caveats</h2></p><p class="my-3">- This plugin is deliberately designed _only_ to embed videos when the URL is on its own line, and not inline with other text.<br />- To do this, it uses <a href="https://regex101.com/r/wSkwtj/13" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">a regular expression</a> to recognize Vimeo video URLs. Currently these are the limitations on what it can recognize in a Markdown parser’s HTML output:<br /> - The URL <em>must</em> be wrapped in a paragraph tag: </code><p><code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"><br /> - It <em>may</em> also be wrapped in an anchor tag, (<em>inside</em> the paragraph): </code><a>`<br /> - The URL string <em>may</em> have whitespace around it<br />- I’ve tried to accommodate common variants, but there are conceivably valid Vimeo URLs that wouldn’t get recognized. Please <a href="https://github.com/gfscott/eleventy-plugin-embed-everything/issues/new" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">file an issue</a> if you run into an edge case!<br />- This plugin uses <a href="https://www.11ty.dev/docs/config/#transforms" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">transforms</a>, so it alters Eleventy’s HTML output as it’s generated. It doesn’t alter the source Markdown.<br />- The embedded video is responsive, using the <a href="https://codepen.io/gfscott/pen/qpKqZR?editors=1100" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">intrinsic aspect ratio</a> method. It will expand to fill whatever horizontal space is available.<br />- The embed dimensions are currently hard-coded to a 16:9 aspect ratio.<br /></p></div><div class="flex justify-center absolute inset-x-0 bottom-0 bg-gradient-to-t from-background via-background to-transparent pb-4 pt-16"><button data-slot="button" class="inline-flex items-center justify-center whitespace-nowrap text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-down mr-1 h-4 w-4"><path d="m6 9 6 6 6-6"></path></svg>Show more</button></div></div></div><template id="P:4"></template><template id="P:5"></template></div></div></div><div hidden id="S:3"><div class="rounded-lg border p-3"><h4 class="mb-2 text-sm font-medium">Dist Tags</h4><div class="space-y-1"><div class="flex justify-between text-sm"><span class="text-muted-foreground">latest</span><a class="font-mono text-xs hover:underline" href="/package/eleventy-plugin-vimeo-embed/v/1.4.0">1.4.0</a></div><div class="flex justify-between text-sm"><span class="text-muted-foreground">unstable</span><a class="font-mono text-xs hover:underline" href="/package/eleventy-plugin-vimeo-embed/v/1.4.0-unstable-a8630c6878ad41b8a578fadf02cb37c2d7558260">1.4.0-unstable-a8630c6878ad41b8a578fadf02cb37c2d7558260</a></div></div></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><div hidden id="S:4"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:4","P:4")</script><div hidden id="S:5"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:5","P:5")</script><script>$RC("B:1","S:1")</script></body></html>