Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaeh committed Dec 7, 2019
1 parent 896da82 commit 3c1e0a7
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="stylesheet" href="/gdpr/magic.css?opxM5N7L56" integrity="sha384-opxM5N7L56sXi4Jk/4lNcanijUd5abErfRBGQkLPvOOdP+umnPKRxYOSdvsRjLj5" crossorigin="anonymous"/><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></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/gdpr/"><span>Gdpr</span></a><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#themes">themes</a></li><li><a href="/gdpr/#source">source</a></li></ul></nav></header><div class="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><div class="Gdpr show"><input type="checkbox" name="show-hide" id="show-hide"/><div class="Container"><h3>Magic Privacy Information</h3><p>This page does neither save, collect, nor share any personal data about you.</p><label class="button" for="show-hide">Awesome.</label></div></div></footer></div></main><script src="/gdpr/magic.js?aiI20E8EYW" integrity="sha384-aiI20E8EYWhDUiKte/oSe5x+xcqCSbD+6lQlQjcLQcIQnP8N7xsfufzumz5djDYF" crossorigin="anonymous"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="stylesheet" href="/gdpr/magic.css?opxM5N7L56" integrity="sha384-opxM5N7L56sXi4Jk/4lNcanijUd5abErfRBGQkLPvOOdP+umnPKRxYOSdvsRjLj5" crossorigin="anonymous"/><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></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/gdpr/"><span>Gdpr</span></a><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#themes">themes</a></li><li><a href="/gdpr/#source">source</a></li></ul></nav></header><div class="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><div class="Gdpr show"><input type="checkbox" name="show-hide" id="show-hide"/><div class="Container"><h3>Magic Privacy Information</h3><p>This page does neither save, collect, nor share any personal data about you.</p><label class="button" for="show-hide">Awesome.</label></div></div></footer></div></main><script src="/gdpr/magic.js?HhX0R0plvX" integrity="sha384-HhX0R0plvXJuo4LgOFaNyyL5a2FhVj9NVoYcamxj9fjY3bDsb6B87gnj4mBB5hsa" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="stylesheet" href="/gdpr/magic.css?opxM5N7L56" integrity="sha384-opxM5N7L56sXi4Jk/4lNcanijUd5abErfRBGQkLPvOOdP+umnPKRxYOSdvsRjLj5" crossorigin="anonymous"/><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></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/gdpr/"><span>Gdpr</span></a><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#themes">themes</a></li><li><a href="/gdpr/#source">source</a></li></ul></nav></header><div class="Page"><h1>@magic-modules/gdpr</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> Gdpr component. 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.svg" role="presentation" alt=""/></a></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" role="presentation" alt=""/></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" role="presentation" alt=""/></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" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/gdpr.svg" role="presentation" alt=""/></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" 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/gdpr</code></pre></div><h2 id="usage">usage:</h2><p>gdpr gets loaded automatically after being installed.</p><p>to configure it, add the object below to /src/app.mjs</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// /src/<span class="object">app</span>.<span class="property">mjs</span></span></code><code class="line"><span class="keyword">export</span> <span class="keyword">const</span> <span class="state">state</span> = {</code><code class="line"> <span class="colon">gdpr</span>: {</code><code class="line"> <span class="colon">show</span>: <span class="boolean">false</span>, <span class="comment">// || <span class="boolean">true</span></span></code><code class="line"> <span class="colon">small</span>: <span class="boolean">false</span>, <span class="comment">// <span class="keyword">if</span> <span class="boolean">true</span>, component has 30% of <span class="object">screen</span>.</span></code><code class="line"> <span class="colon">left</span>: <span class="boolean">false</span>, <span class="comment">// popup is positioned to the left <span class="keyword">if</span> <span class="boolean">true</span></span></code><code class="line"> <span class="colon">right</span>: <span class="boolean">false</span>, <span class="comment">// popup is positioned to the right <span class="keyword">if</span> <span class="boolean">true</span></span></code><code class="line"> <span class="colon">title</span>: <span class="string">&#39;Main popup title&#39;</span>,</code><code class="line"> <span class="colon">content</span>: [p(<span class="string">&#39;text of cookie&#39;</span>), p(<span class="string">&#39;popup&#39;</span>),</code><code class="line"> <span class="colon">noCookieText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">noCookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">cookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">allowAllCookiesButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">allowCookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">denyCookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">cookieText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> },</code><code class="line"> <span class="colon">cookies</span>: [</code><code class="line"> [<span class="string">&#39;name&#39;</span>, { <span class="colon">info</span>: <span class="string">&#39;cookie description&#39;</span> }],</code><code class="line"> [<span class="string">&#39;cookie 2&#39;</span>, { <span class="colon">info</span>: [h3(<span class="string">&#39;cookie title&#39;</span>, <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><button class="LightSwitch"></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><div class="Gdpr show"><input type="checkbox" name="show-hide" id="show-hide"/><div class="Container"><h3>Magic Privacy Information</h3><p>This page does neither save, collect, nor share any personal data about you.</p><label class="button" for="show-hide">Awesome.</label></div></div></footer></div></main><script src="/gdpr/magic.js?aiI20E8EYW" integrity="sha384-aiI20E8EYWhDUiKte/oSe5x+xcqCSbD+6lQlQjcLQcIQnP8N7xsfufzumz5djDYF" crossorigin="anonymous"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="stylesheet" href="/gdpr/magic.css?opxM5N7L56" integrity="sha384-opxM5N7L56sXi4Jk/4lNcanijUd5abErfRBGQkLPvOOdP+umnPKRxYOSdvsRjLj5" crossorigin="anonymous"/><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></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/gdpr/"><span>Gdpr</span></a><nav class="Menu"><ul><li><a href="/gdpr/#installation">installation</a></li><li><a href="/gdpr/#usage">usage</a></li><li><a href="/gdpr/#themes">themes</a></li><li><a href="/gdpr/#source">source</a></li></ul></nav></header><div class="Page"><h1>@magic-modules/gdpr</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> Gdpr component. 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.svg" role="presentation" alt=""/></a></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" role="presentation" alt=""/></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" role="presentation" alt=""/></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" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/gdpr.svg" role="presentation" alt=""/></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" 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/gdpr</code></pre></div><h2 id="usage">usage:</h2><p>gdpr gets loaded automatically after being installed.</p><p>to configure it, add the object below to /src/app.mjs</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// /src/<span class="object">app</span>.<span class="property">mjs</span></span></code><code class="line"><span class="keyword">export</span> <span class="keyword">const</span> <span class="state">state</span> = {</code><code class="line"> <span class="colon">gdpr</span>: {</code><code class="line"> <span class="colon">show</span>: <span class="boolean">false</span>, <span class="comment">// || <span class="boolean">true</span></span></code><code class="line"> <span class="colon">small</span>: <span class="boolean">false</span>, <span class="comment">// <span class="keyword">if</span> <span class="boolean">true</span>, component has 30% of <span class="object">screen</span>.</span></code><code class="line"> <span class="colon">left</span>: <span class="boolean">false</span>, <span class="comment">// popup is positioned to the left <span class="keyword">if</span> <span class="boolean">true</span></span></code><code class="line"> <span class="colon">right</span>: <span class="boolean">false</span>, <span class="comment">// popup is positioned to the right <span class="keyword">if</span> <span class="boolean">true</span></span></code><code class="line"> <span class="colon">title</span>: <span class="string">&#39;Main popup title&#39;</span>,</code><code class="line"> <span class="colon">content</span>: [p(<span class="string">&#39;text of cookie&#39;</span>), p(<span class="string">&#39;popup&#39;</span>),</code><code class="line"> <span class="colon">noCookieText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">noCookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">cookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">allowAllCookiesButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">allowCookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">denyCookieButtonText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> <span class="colon">cookieText</span>: <span class="string">&#39;<span class="builtin">String</span> or <span class="builtin">Array</span> of Magic modules&#39;</span>,</code><code class="line"> },</code><code class="line"> <span class="colon">cookies</span>: [</code><code class="line"> [<span class="string">&#39;name&#39;</span>, { <span class="colon">info</span>: <span class="string">&#39;cookie description&#39;</span> }],</code><code class="line"> [<span class="string">&#39;cookie 2&#39;</span>, { <span class="colon">info</span>: [h3(<span class="string">&#39;cookie title&#39;</span>, <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><button class="LightSwitch"></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><div class="Gdpr show"><input type="checkbox" name="show-hide" id="show-hide"/><div class="Container"><h3>Magic Privacy Information</h3><p>This page does neither save, collect, nor share any personal data about you.</p><label class="button" for="show-hide">Awesome.</label></div></div></footer></div></main><script src="/gdpr/magic.js?HhX0R0plvX" integrity="sha384-HhX0R0plvXJuo4LgOFaNyyL5a2FhVj9NVoYcamxj9fjY3bDsb6B87gnj4mBB5hsa" crossorigin="anonymous"></script></body></html>
Loading

0 comments on commit 3c1e0a7

Please sign in to comment.