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 1, 2020
1 parent dc1b462 commit 979e401
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 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?D436yquKNY" integrity="sha384-D436yquKNYjRDl9PQT2FMFOLSOqF2ESUEtR3gdzMQmihibnYcbf+ihp/57mvaabf" 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?AOgv9hi2ll" integrity="sha384-AOgv9hi2llWVV5/ozgpfDdjguzmObnxS6Wc4nkFSIKQd7bonhU5h7F/WTWjnUq1B" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/index.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"><h1>@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 id to the VideoEmbed module.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">VideoEmbed(<span class="string">&#39;ecIWPzGEbFc&#39;</span>)</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 id 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">VideoEmbed(153090637)</code><code class="line">VideoEmbed(<span class="string">&#39;153090637&#39;</span>)</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://player.vimeo.com/video/153090637"></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">VideoEmbed(&#39;https://videopress.com/embed/kUJmAcSf&#39;)</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, a style object and any other props to the video.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">VideoEmbed({ <span class="colon">src</span>: <span class="string">&#39;8QYWGCEm2Dc&#39;</span>, <span class="colon">width</span>: <span class="string">&#39;50%&#39;</span>, <span class="colon">height</span>: 200, <span class="colon">style</span>: { <span class="colon">margin</span>: <span class="string">&#39;1em 0 0&#39;</span> } })</code></pre></div><p>renders</p><div class="VideoEmbed" style="width:50%"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/8QYWGCEm2Dc"></iframe></div><h3 id="fixed-dimensions">fixed video 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">VideoEmbed({ <span class="colon">src</span>: <span class="string">&#39;SMhwddNQSWQ&#39;</span>, <span class="colon">width</span>: <span class="string">&#39;300px&#39;</span>, <span class="colon">height</span>: <span class="string">&#39;900px&#39;</span> })</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/SMhwddNQSWQ"></iframe></div><h2 id="source">source</h2><p>the source for this page is in the <a href="https://github.com/magic-modules/video-embed/tree/master/example" target="_blank" rel="noopener">example directory</a> and gets built and published to github using <a href="https://github.com/magic/core" target="_blank" rel="noopener">@magic/core</a></p><button class="LightSwitch"><svg viewBox="0 0 352 460"><path d="M149 48C96 48 48 95 47 143c-1 13 19 17 20 0-1-35 48-75 83-75 15 0 12-22-1-20z"></path><path d="M176 0C74 0 0 83 0 176c9 91 84 118 100 204h20c-16-92-97-138-100-204C22 70 105 21 176 20zM95 400c2 68 20 48 40 60h82c20-12 38 8 40-60z"></path><path d="M175 0c102 0 177 83 177 176-9 91-86 118-102 204h-20c16-92 99-138 102-204-2-106-86-155-157-156z"></path></svg></button></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?D436yquKNY" integrity="sha384-D436yquKNYjRDl9PQT2FMFOLSOqF2ESUEtR3gdzMQmihibnYcbf+ihp/57mvaabf" 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"><h1>@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 id to the VideoEmbed module.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">VideoEmbed(<span class="string">&#39;ecIWPzGEbFc&#39;</span>)</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 id 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">VideoEmbed(153090637)</code><code class="line">VideoEmbed(<span class="string">&#39;153090637&#39;</span>)</code></pre></div><p>renders</p><div class="VideoEmbed"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://player.vimeo.com/video/153090637"></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">VideoEmbed(&#39;https://videopress.com/embed/kUJmAcSf&#39;)</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, a style object and any other props to the video.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">VideoEmbed({ <span class="colon">src</span>: <span class="string">&#39;8QYWGCEm2Dc&#39;</span>, <span class="colon">width</span>: <span class="string">&#39;50%&#39;</span>, <span class="colon">height</span>: 200, <span class="colon">style</span>: { <span class="colon">margin</span>: <span class="string">&#39;1em 0 0&#39;</span> } })</code></pre></div><p>renders</p><div class="VideoEmbed" style="width:50%"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/8QYWGCEm2Dc"></iframe></div><h3 id="fixed-dimensions">fixed video 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">VideoEmbed({ <span class="colon">src</span>: <span class="string">&#39;SMhwddNQSWQ&#39;</span>, <span class="colon">width</span>: <span class="string">&#39;300px&#39;</span>, <span class="colon">height</span>: <span class="string">&#39;900px&#39;</span> })</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/SMhwddNQSWQ"></iframe></div><h2 id="source">source</h2><p>the source for this page is in the <a href="https://github.com/magic-modules/video-embed/tree/master/example" target="_blank" rel="noopener">example directory</a> and gets built and published to github using <a href="https://github.com/magic/core" target="_blank" rel="noopener">@magic/core</a></p><button class="LightSwitch"><svg viewBox="0 0 352 460"><path d="M149 48C96 48 48 95 47 143c-1 13 19 17 20 0-1-35 48-75 83-75 15 0 12-22-1-20z"></path><path d="M176 0C74 0 0 83 0 176c9 91 84 118 100 204h20c-16-92-97-138-100-204C22 70 105 21 176 20zM95 400c2 68 20 48 40 60h82c20-12 38 8 40-60z"></path><path d="M175 0c102 0 177 83 177 176-9 91-86 118-102 204h-20c16-92 99-138 102-204-2-106-86-155-157-156z"></path></svg></button></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?AOgv9hi2ll" integrity="sha384-AOgv9hi2llWVV5/ozgpfDdjguzmObnxS6Wc4nkFSIKQd7bonhU5h7F/WTWjnUq1B" crossorigin="anonymous"></script></body></html>

0 comments on commit 979e401

Please sign in to comment.