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 8b2d49c commit f772306
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
View file
@@ -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="/gdpr/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="/gdpr/magic.css?Wi9faqSbI+" integrity="sha384-Wi9faqSbI+ITATz8u1GY10j42nh3Zdl/9buo3WCUzPSc0dHP2XyMCNBifq+nf47p" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/gdpr/"><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>Gdpr</p><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#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="/gdpr/magic.js?uatJhLW9H/" integrity="sha384-uatJhLW9H/VgBC4fHC8b+5zSlBkeDrgGQpVvkSo3pBjnL7FfUuMUAHRSEBskejbX" 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="/gdpr/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="/gdpr/magic.css?CwSx5l4tph" integrity="sha384-CwSx5l4tph+FTpxYom8zsYncI+QREjy8Q4GSWdjz4MGli+K9as0a46Ij1NlaN4Ko" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/gdpr/"><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>Gdpr</p><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#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="/gdpr/magic.js?c1EUGEc6Cp" integrity="sha384-c1EUGEc6Cpb99OG1ASQxAvDmEyJkqjmHiK47Z6C4VbI70WGWtUZk2zkUyuZSukEg" crossorigin="anonymous"></script></body></html>
4 changes: 2 additions & 2 deletions docs/index.html
View file
@@ -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="/gdpr/favicon.ico"/><title>@magic-modules/gdpr</title><meta name="description" content="adds a gdpr compliant information popup with minimal intrusion and complexity to your page."/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/gdpr"}</script><link rel="stylesheet" href="/gdpr/magic.css?Wi9faqSbI+" integrity="sha384-Wi9faqSbI+ITATz8u1GY10j42nh3Zdl/9buo3WCUzPSc0dHP2XyMCNBifq+nf47p" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/gdpr/"><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>Gdpr</p><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#source">source</a></li></ul></nav></div></header><div class="Page" id="page"><h1 id="magic-modulesgdpr">@magic-modules/gdpr</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="/gdpr/favicon.ico"/><title>@magic-modules/gdpr</title><meta name="description" content="adds a gdpr compliant information popup with minimal intrusion and complexity to your page."/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/gdpr"}</script><link rel="stylesheet" href="/gdpr/magic.css?CwSx5l4tph" integrity="sha384-CwSx5l4tph+FTpxYom8zsYncI+QREjy8Q4GSWdjz4MGli+K9as0a46Ij1NlaN4Ko" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/gdpr/"><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>Gdpr</p><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#source">source</a></li></ul></nav></div></header><div class="Page" id="page"><h1 id="magic-modulesgdpr">@magic-modules/gdpr</h1><p>this is the
<a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a>
Gdpr component.</p><p>adds a gdpr compliant information popup with minimal intrusion and complexity to your page.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/gdpr" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/gdpr?color=blue" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><img src="https://img.shields.io/node/v/@magic-modules/gdpr?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><img src="https://img.shields.io/npm/l/@magic-modules/gdpr?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><a href="https://travis-ci.com/magic-modules/gdpr" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic-modules/gdpr/master" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/gdpr/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/gdpr/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://coveralls.io/github/magic-modules/gdpr" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic-modules/gdpr/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://snyk.io/test/github/magic-modules/gdpr" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic-modules/gdpr.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> --save-exact @magic-modules/gdpr</code></pre></div><h2 id="usage">usage</h2><h3 id="activate">activate</h3><p>to activate Gdpr, add it to the list of hoisted modules</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// src/config.mjs</span></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="comment">// ... other config variables</span></code><code class="line"></code><code class="line"> HOIST: [<span class="string">&#39;Gdpr&#39;</span>],</code><code class="line">}</code></pre></div><p>after doing this, the gdpr module will show up.&#39;),</p><h3 id="change-contents-add-cookies">change contents, add cookies</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// /src/app.mjs</span></code><code class="line"><span class="keyword">export</span> <span class="keyword">const</span> <span class="state">state</span> = {</code><code class="line"> gdpr: {</code><code class="line"> allowAllText: <span class="string">&#39;button text for allow all data&#39;</span>,</code><code class="line"> allowText: <span class="string">&#39;button text for allow selected data&#39;</span>,</code><code class="line"> allowTitle: <span class="string">&#39;Title above the three cookie buttons&#39;</span>,</code><code class="line"> content: <span class="string">&#39;String or Array of Magic modules&#39;</span>,</code><code class="line"> denyText: <span class="string">&#39;button text for no data allowed&#39;</span>,</code><code class="line"> noDataText: <span class="string">&#39;Button text if no cookies are defined&#39;</span>,</code><code class="line"> title: <span class="string">&#39;Title text for the gdpr popup&#39;</span>,</code><code class="line"> },</code><code class="line"> cookies: [</code><code class="line"> [<span class="string">&#39;name&#39;</span>, { title: <span class="string">&#39;cookie1 title&#39;</span>, content: <span class="string">&#39;cookie description&#39;</span> }],</code><code class="line"> [<span class="string">&#39;cookie 2&#39;</span>, { title: <span class="string">&#39;cookie title&#39;</span>, content: <span class="string">&#39;cookie content&#39;</span> }],</code><code class="line"> ],</code><code class="line">})</code></pre></div><h2 id="source">source</h2><p>the source for this page is in the
<a href="https://github.com/magic-modules/gdpr/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="/gdpr/magic.js?uatJhLW9H/" integrity="sha384-uatJhLW9H/VgBC4fHC8b+5zSlBkeDrgGQpVvkSo3pBjnL7FfUuMUAHRSEBskejbX" 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="/gdpr/magic.js?c1EUGEc6Cp" integrity="sha384-c1EUGEc6Cpb99OG1ASQxAvDmEyJkqjmHiK47Z6C4VbI70WGWtUZk2zkUyuZSukEg" crossorigin="anonymous"></script></body></html>

0 comments on commit f772306

Please sign in to comment.