Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Jul 18, 2020
1 parent d2926ca commit 5a1577f
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 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>404 - not found</title><meta name="description" content="404 - not found."/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"404 - not found"}</script><link rel="stylesheet" href="/video-embed/magic.css?zZWN/yrKh0" integrity="sha384-zZWN/yrKh0LVMl9KAzAZhUGw8GgbyzsAh8Wcr4ToQRbFLNUAItG8xBbfdLbh/TKG" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/video-embed/"><svg viewBox="0 0 512 444"><path d="M512 444L256 0 0 444z" fill="#663695"></path><circle cx="256" cy="294" r="130" fill="#fff"></circle><circle cx="256" cy="281" r="40" fill="#663695"></circle><path d="M256 350v44m24-44l1 13c1 27 29 27 29-7m-160-72s46-47 106-47c59 0 106 47 106 47s-47 43-106 43c-60 0-106-43-106-43zm65-75a134 134 0 0189 2" class="stroke"></path><path d="M256 81v53m184 270l-43-29M72 404l43-29" class="stroke white"></path></svg></a><p>VideoEmbed</p><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></div></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://magic.github.io/">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?HNDLygqMli" integrity="sha384-HNDLygqMliTXu3LklIaF11aw5pq8KTej8iTd4i78ePnMkmOA4T3IboBPB3MqrJ28" 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>404 - not found</title><meta name="description" content="404 - not found."/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"404 - not found"}</script><link rel="stylesheet" href="/video-embed/magic.css?iHKLvlsg9X" integrity="sha384-iHKLvlsg9XTghrzH7CEJRyJbdjBePoNjsmQGolj6hoYwYWSQHe0UESCrelDIz7pD" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/video-embed/"><svg viewBox="0 0 512 444"><path d="M512 444L256 0 0 444z" fill="#663695"></path><circle cx="256" cy="294" r="130" fill="#fff"></circle><circle cx="256" cy="281" r="40" fill="#663695"></circle><path d="M256 350v44m24-44l1 13c1 27 29 27 29-7m-160-72s46-47 106-47c59 0 106 47 106 47s-47 43-106 43c-60 0-106-43-106-43zm65-75a134 134 0 0189 2" class="stroke"></path><path d="M256 81v53m184 270l-43-29M72 404l43-29" class="stroke white"></path></svg></a><p>VideoEmbed</p><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></div></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://magic.github.io/">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?gsbUQiLgKj" integrity="sha384-gsbUQiLgKjbGYEkDvSu3/rQF2V1B1iW0C88u2ydHLXbW6UIEvetpUZKoO3a1MiB/" 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,7 +1,7 @@
<!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?zZWN/yrKh0" integrity="sha384-zZWN/yrKh0LVMl9KAzAZhUGw8GgbyzsAh8Wcr4ToQRbFLNUAItG8xBbfdLbh/TKG" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/video-embed/"><svg viewBox="0 0 512 444"><path d="M512 444L256 0 0 444z" fill="#663695"></path><circle cx="256" cy="294" r="130" fill="#fff"></circle><circle cx="256" cy="281" r="40" fill="#663695"></circle><path d="M256 350v44m24-44l1 13c1 27 29 27 29-7m-160-72s46-47 106-47c59 0 106 47 106 47s-47 43-106 43c-60 0-106-43-106-43zm65-75a134 134 0 0189 2" class="stroke"></path><path d="M256 81v53m184 270l-43-29M72 404l43-29" class="stroke white"></path></svg></a><p>VideoEmbed</p><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></div></header><div class="Page" id="page"><h1 id="magic-modulesvideo-embed">@magic-modules/video-embed,</h1><p>this is the
<!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?iHKLvlsg9X" integrity="sha384-iHKLvlsg9XTghrzH7CEJRyJbdjBePoNjsmQGolj6hoYwYWSQHe0UESCrelDIz7pD" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/video-embed/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/video-embed/"><svg viewBox="0 0 512 444"><path d="M512 444L256 0 0 444z" fill="#663695"></path><circle cx="256" cy="294" r="130" fill="#fff"></circle><circle cx="256" cy="281" r="40" fill="#663695"></circle><path d="M256 350v44m24-44l1 13c1 27 29 27 29-7m-160-72s46-47 106-47c59 0 106 47 106 47s-47 43-106 43c-60 0-106-43-106-43zm65-75a134 134 0 0189 2" class="stroke"></path><path d="M256 81v53m184 270l-43-29M72 404l43-29" class="stroke white"></path></svg></a><p>VideoEmbed</p><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></div></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?color=blue" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><img src="https://img.shields.io/node/v/@magic-modules/video-embed?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><img src="https://img.shields.io/npm/l/@magic-modules/video-embed?color=blue" height="23" role="presentation" alt="" loading="lazy"/></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" height="23" role="presentation" alt="" loading="lazy"/></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" height="23" role="presentation" alt="" loading="lazy"/></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" height="23" role="presentation" alt="" loading="lazy"/></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" height="23" role="presentation" alt="" loading="lazy"/></a></li></ul><h2 id="installation">installation</h2><div class="Pre"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> <span class="keyword">install</span> @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"><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"><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"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=<span class="string">&quot;https://videopress.com/embed/kUJmAcSf&quot;</span>&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"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;VideoEmbed src=<span class="string">&quot;tIxHmsWCd7g&quot;</span> width=<span class="string">&quot;50%&quot;</span> height=<span class="string">&quot;200&quot;</span>&gt;&lt;/VideoEmbed&gt;</code></pre></div><p>renders
<div class="VideoEmbed" style="height:200px;width:50%"><iframe frameborder="0" allow="encrypted-media" allowfullscreen="" src="https://www.youtube-nocookie.com/embed/tIxHmsWCd7g"></iframe></div></p><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"><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><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></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://magic.github.io/">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?HNDLygqMli" integrity="sha384-HNDLygqMliTXu3LklIaF11aw5pq8KTej8iTd4i78ePnMkmOA4T3IboBPB3MqrJ28" crossorigin="anonymous"></script></body></html>
<a href="https://github.com/magic/core" target="_blank" rel="noopener">@magic/core</a></p></div><footer class="Footer"><div class="Container"><div class="Credits">made with a few bits of <a target="_blank" rel="noopener" href="https://magic.github.io/">magic</a></div></div></footer></div></main><script src="/video-embed/magic.js?gsbUQiLgKj" integrity="sha384-gsbUQiLgKjbGYEkDvSu3/rQF2V1B1iW0C88u2ydHLXbW6UIEvetpUZKoO3a1MiB/" crossorigin="anonymous"></script></body></html>

0 comments on commit 5a1577f

Please sign in to comment.