Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Mar 3, 2020
1 parent fd8abd1 commit 8f027f2
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link rel="icon" href="/video-embed/favicon.ico"/><title>@magic-modules/video-embed</title><meta name="description" content="renders videos from any http url that allows iframe embedding"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/video-embed"}</script><link rel="stylesheet" href="/video-embed/magic.css?p3b/KPYhEH" integrity="sha384-p3b/KPYhEHsXnFI0HoBEmxsHXrZ3/eOm8Tx4p0zhT6klbhxhQVH62ZY2ciEcK/IF" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/video-embed/"><span>VideoEmbed</span></a><nav class="Menu"><ul><li><a href="/video-embed/#installation">installation</a></li><li><a href="/video-embed/#usage">usage</a></li><li><a href="/video-embed/#props">props</a></li><li><a href="/video-embed/#fixed-dimensions">fixed dimensions</a></li><li><a href="/video-embed/#source">source</a></li></ul></nav></header><div class="Page" id="page"><div>404 - not found</div></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?R7FmY9fwaj" integrity="sha384-R7FmY9fwajvoQkJeLlR0PzpPkXZrbWYBpXNWpFOqjZpugw8JN7ZeHir43ep1pClD" crossorigin="anonymous"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link rel="icon" href="/video-embed/favicon.ico"/><title>@magic-modules/video-embed</title><meta name="description" content="renders videos from any http url that allows iframe embedding"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/video-embed"}</script><link rel="stylesheet" href="/video-embed/magic.css?p3b/KPYhEH" integrity="sha384-p3b/KPYhEHsXnFI0HoBEmxsHXrZ3/eOm8Tx4p0zhT6klbhxhQVH62ZY2ciEcK/IF" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/video-embed/"><span>VideoEmbed</span></a><nav class="Menu"><ul><li><a href="/video-embed/#installation">installation</a></li><li><a href="/video-embed/#usage">usage</a></li><li><a href="/video-embed/#props">props</a></li><li><a href="/video-embed/#fixed-dimensions">fixed dimensions</a></li><li><a href="/video-embed/#source">source</a></li></ul></nav></header><div class="Page" id="page"><div>404 - not found</div></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?PMErVFWZHH" integrity="sha384-PMErVFWZHHf3AfbQDdiK8ZVZx8FSXohC/SgVGC9s7P1JM22JSxYlNKuObIqeINw5" crossorigin="anonymous"></script></body></html>
4 changes: 2 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><link rel="icon" href="/video-embed/favicon.ico"/><title>@magic-modules/video-embed</title><meta name="description" content="renders videos from any http url that allows iframe embedding"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/video-embed"}</script><link rel="stylesheet" href="/video-embed/magic.css?p3b/KPYhEH" integrity="sha384-p3b/KPYhEHsXnFI0HoBEmxsHXrZ3/eOm8Tx4p0zhT6klbhxhQVH62ZY2ciEcK/IF" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="" target="_blank" rel="noopener"><span>VideoEmbed</span></a><nav class="Menu"><ul><li><a href="/video-embed/#installation">installation</a></li><li><a href="/video-embed/#usage">usage</a></li><li><a href="/video-embed/#props">props</a></li><li><a href="/video-embed/#fixed-dimensions">fixed dimensions</a></li><li><a href="/video-embed/#source">source</a></li></ul></nav></header><div class="Page" id="page"><h1 id="magic-modulesvideo-embed">@magic-modules/video-embed,</h1><p>this is the
<a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a>
VideoEmbed component. It renders videos from any http url that allows iframe embedding.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/video-embed.svg" role="presentation" alt=""/></a></li><li><img src="https://img.shields.io/node/v/@magic/core" role="presentation" alt=""/></li><li><a href="https://travis-ci.com/magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic-modules/video-embed/master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/video-embed/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/video-embed/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic-modules/video-embed/master.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/video-embed.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic-modules/video-embed.svg" role="presentation" alt=""/></a></li></ul><h2 id="installation">installation</h2><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">npm install @magic-modules/video-embed</code></pre></div><h2 id="usage">usage</h2><h3 id="usage-youtube">youtube</h3><p>in a page/component, just pass a video src to the VideoEmbed module.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=<span class="string">&#39;ecIWPzGEbFc&#39;</span>&gt;&lt;/VideoEmbed&gt;</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/ecIWPzGEbFc"></iframe></div><h3 id="usage-vimeo">vimeo</h3><p>if the video src is a number, the video is assumed to be hosted on vimeo</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed&gt;116582567&lt;/VideoEmbed&gt;</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://player.vimeo.com/video/116582567"></iframe></div><h4 id="usage-others">other video hosts</h4><p>videos from arbitrary hosts can be included as well, as long as those hosts allow iframe embeds</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=&quot;https://videopress.com/embed/kUJmAcSf&quot;&gt;&lt;/VideoEmbed&gt;</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://videopress.com/embed/kUJmAcSf"></iframe></div><h2 id="props">props</h2><p>you can pass a width and height, and any other props to the video.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed</code><code class="line"> src=<span class="string">&#39;8QYWGCEm2Dc&#39;</span></code><code class="line"> width=<span class="string">&#39;50%&#39;</span></code><code class="line"> height=<span class="string">&#39;200&#39;</span></code><code class="line">&gt;&lt;VideoEmbed&gt;</code></pre></div><p>renders</p><p>&lt;VideoEmbed
VideoEmbed component. It renders videos from any http url that allows iframe embedding.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/video-embed.svg" role="presentation" alt=""/></a></li><li><img src="https://img.shields.io/node/v/@magic/core" role="presentation" alt=""/></li><li><a href="https://travis-ci.com/magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic-modules/video-embed/master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/video-embed/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/video-embed/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic-modules/video-embed/master.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/video-embed.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-modules/video-embed" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic-modules/video-embed.svg" role="presentation" alt=""/></a></li></ul><h2 id="installation">installation</h2><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">npm install @magic-modules/video-embed</code></pre></div><h2 id="usage">usage</h2><h3 id="usage-youtube">youtube</h3><p>in a page/component, just pass a video src to the VideoEmbed module.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=<span class="string">&quot;ecIWPzGEbFc&quot;</span>&gt;&lt;/VideoEmbed&gt;</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/ecIWPzGEbFc"></iframe></div><h3 id="usage-vimeo">vimeo</h3><p>if the video src is a number, the video is assumed to be hosted on vimeo</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed&gt;116582567&lt;/VideoEmbed&gt;</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://player.vimeo.com/video/116582567"></iframe></div><h4 id="usage-others">other video hosts</h4><p>videos from arbitrary hosts can be included as well, as long as those hosts allow iframe embeds</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=&quot;<span class="colon">https</span>:<span class="comment">//<span class="object">videopress</span>.<span class="property">com</span>/embed/kUJmAcSf&quot;&gt;&lt;/VideoEmbed&gt; </span></code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://videopress.com/embed/kUJmAcSf"></iframe></div><h2 id="props">props</h2><p>you can pass a width and height, and any other props to the video.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed</code><code class="line"> src=<span class="string">&quot;8QYWGCEm2Dc&quot;</span></code><code class="line"> width=<span class="string">&quot;50%&quot;</span></code><code class="line"> height=<span class="string">&quot;200&quot;</span></code><code class="line">&gt;&lt;VideoEmbed&gt;</code></pre></div><p>renders</p><p>&lt;VideoEmbed
src=&amp;quot;8QYWGCEm2Dc&amp;quot;
width=&amp;quot;50%&amp;quot;
height=&amp;quot;200&amp;quot;</p><blockquote></blockquote><h3 id="fixed-dimensions">fixed-dimensions</h3><p>to set a fixed video size, simply add both a height and a width value (px, em, rem, vh, pt).</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=<span class="string">&#39;E-dUveGINTg&#39;</span> width=<span class="string">&#39;300px&#39;</span> height=<span class="string">&#39;900px&#39;</span>&gt;&lt;VideoEmbed&gt;</code></pre></div><div class="VideoEmbed" style="height:900px;width:300px"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/E-dUveGINTg"></iframe></div></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?R7FmY9fwaj" integrity="sha384-R7FmY9fwajvoQkJeLlR0PzpPkXZrbWYBpXNWpFOqjZpugw8JN7ZeHir43ep1pClD" crossorigin="anonymous"></script></body></html>
height=&amp;quot;200&amp;quot;</p><blockquote></blockquote><h3 id="fixed-dimensions">fixed-dimensions</h3><p>to set a fixed video size, simply add both a height and a width value (px, em, rem, vh, pt).</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=<span class="string">&quot;E-dUveGINTg&quot;</span> width=<span class="string">&quot;300px&quot;</span> height=<span class="string">&quot;900px&quot;</span>&gt;&lt;VideoEmbed&gt;</code></pre></div><div class="VideoEmbed" style="height:900px;width:300px"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/E-dUveGINTg"></iframe></div></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?PMErVFWZHH" integrity="sha384-PMErVFWZHHf3AfbQDdiK8ZVZx8FSXohC/SgVGC9s7P1JM22JSxYlNKuObIqeINw5" crossorigin="anonymous"></script></body></html>
Loading

0 comments on commit 8f027f2

Please sign in to comment.