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 57b15af commit b750bf8
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 9 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="/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?kUrAPicEg3" integrity="sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><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/#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="/gdpr/magic.js?PQoU7cibpN" integrity="sha384-PQoU7cibpNRZiB9X1sWPlGOZJxi77nT8vJSwkmAU5+doYC0CAMLwGa1fOIyXdhWC" 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>@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?kUrAPicEg3" integrity="sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><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/#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="/gdpr/magic.js?SnBZdWeYNB" integrity="sha384-SnBZdWeYNBirEN3ZdwiRNFMLRg6YGITWokz9TrpwndVBkf72l+OuWSyUAUoXrvIb" crossorigin="anonymous"></script></body></html>
7 changes: 6 additions & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1 +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?kUrAPicEg3" integrity="sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><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/#source">source</a></li></ul></nav></header><div class="Page" id="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><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="colon">allowAllText</span>: all</code><code class="line"><span class="colon">allowText</span>: selected</code><code class="line"><span class="colon">allowTitle</span>: Title above the three cookie buttons</code><code class="line"><span class="colon">allowed</span>: </code><code class="line"><span class="colon">content</span>: Popup content text</code><code class="line"><span class="colon">denyText</span>: none</code><code class="line"><span class="colon">noDataText</span>: Button text <span class="keyword">if</span> no cookies are defined</code><code class="line"><span class="colon">show</span>: <span class="boolean">false</span></code><code class="line"><span class="colon">title</span>: Popup title</code></pre></div><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><img src="https://img.shields.io/node/v/@magic/core" role="presentation" alt=""/></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><h3>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/<span class="object">config</span>.<span class="property">mjs</span></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"> <span class="colon">HOIST</span>: [<span class="string">&#39;Gdpr&#39;</span>],</code><code class="line">}</code></pre></div><p>after doing this, the gdpr module will show up.</p><h3>change contents, add cookies:</h3><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">allowAllText</span>: <span class="string">&#39;button text <span class="keyword">for</span> allow all data&#39;</span>,</code><code class="line"> <span class="colon">allowText</span>: <span class="string">&#39;button text <span class="keyword">for</span> allow selected data&#39;</span>,</code><code class="line"> <span class="colon">allowTitle</span>: <span class="string">&#39;Title above the three cookie buttons&#39;</span>,</code><code class="line"> <span class="colon">content</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">denyText</span>: <span class="string">&#39;button text <span class="keyword">for</span> no data allowed&#39;</span>,</code><code class="line"> <span class="colon">noDataText</span>: <span class="string">&#39;Button text <span class="keyword">if</span> no cookies are defined&#39;</span>,</code><code class="line"> <span class="colon">title</span>: <span class="string">&#39;Title text <span class="keyword">for</span> the gdpr popup&#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">title</span>: <span class="string">&#39;cookie1 title&#39;</span>, <span class="colon">content</span>: <span class="string">&#39;cookie description&#39;</span> }],</code><code class="line"> [<span class="string">&#39;cookie 2&#39;</span>, { <span class="colon">title</span>: <span class="string">&#39;cookie title&#39;</span>, <span class="colon">content</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"><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="/gdpr/magic.js?PQoU7cibpN" integrity="sha384-PQoU7cibpNRZiB9X1sWPlGOZJxi77nT8vJSwkmAU5+doYC0CAMLwGa1fOIyXdhWC" 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>@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?kUrAPicEg3" integrity="sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/gdpr/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="" target="_blank" rel="noopener"><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/#source">source</a></li></ul></nav></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.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/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 --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/<span class="object">config</span>.<span class="property">mjs</span></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"> <span class="colon">HOIST</span>: [<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/<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">allowAllText</span>: <span class="string">&#39;button text <span class="keyword">for</span> allow all data&#39;</span>,</code><code class="line"> <span class="colon">allowText</span>: <span class="string">&#39;button text <span class="keyword">for</span> allow selected data&#39;</span>,</code><code class="line"> <span class="colon">allowTitle</span>: <span class="string">&#39;Title above the three cookie buttons&#39;</span>,</code><code class="line"> <span class="colon">content</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">denyText</span>: <span class="string">&#39;button text <span class="keyword">for</span> no data allowed&#39;</span>,</code><code class="line"> <span class="colon">noDataText</span>: <span class="string">&#39;Button text <span class="keyword">if</span> no cookies are defined&#39;</span>,</code><code class="line"> <span class="colon">title</span>: <span class="string">&#39;Title text <span class="keyword">for</span> the gdpr popup&#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">title</span>: <span class="string">&#39;cookie1 title&#39;</span>, <span class="colon">content</span>: <span class="string">&#39;cookie description&#39;</span> }],</code><code class="line"> [<span class="string">&#39;cookie 2&#39;</span>, { <span class="colon">title</span>: <span class="string">&#39;cookie title&#39;</span>, <span class="colon">content</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></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="/gdpr/magic.js?SnBZdWeYNB" integrity="sha384-SnBZdWeYNBirEN3ZdwiRNFMLRg6YGITWokz9TrpwndVBkf72l+OuWSyUAUoXrvIb" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/magic.js
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

<url>
<loc>https://magic-modules.github.io/gpdr/</loc>
<lastmod>2020-03-02</lastmod>
<lastmod>2020-03-03</lastmod>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>

<url>
<loc>https://magic-modules.github.io/gpdr/404/</loc>
<lastmod>2020-03-02</lastmod>
<lastmod>2020-03-03</lastmod>
<changefreq>weekly</changefreq>
<priority>0.5</priority>
</url>
Expand Down
8 changes: 4 additions & 4 deletions docs/sri-hashes.json
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"css": "sha384-kUrAPicEg3qZBlaW32CA75F1Aj96PM+GUTu4MsGlIqZmNTBmJtsJifLdiKKOkWLy",
"js": "sha384-PQoU7cibpNRZiB9X1sWPlGOZJxi77nT8vJSwkmAU5+doYC0CAMLwGa1fOIyXdhWC",
"js": "sha384-SnBZdWeYNBirEN3ZdwiRNFMLRg6YGITWokz9TrpwndVBkf72l+OuWSyUAUoXrvIb",
"pages": {
"/gdpr/": "sha384-vEEFaVSknMCVi65uL8kbiWiHQ/rTdZWv8XeWFMg6It5QKex1xsC/T0wJoxPrzSv4",
"/gdpr/404/": "sha384-YMuxoJMNgL9LFohqlceTX7AmVNykgUbnqUpGLarPPQNQz9pMaxxzl1R6AdMb0Ygf"
"/gdpr/": "sha384-5GOgwsCWkKyGRXeUDhVRnEq5kY0rTz9TMfgzz5bgpCR/2+RLDdQG97NPVBs13YWe",
"/gdpr/404/": "sha384-a8VD1LuVJmtowbIe0lYm8cUrz/KbA+cfulXvTGDqfhXGldWeq0XhHWEv/uLkw6LY"
},
"static": {
"/favicon.ico": "sha384-pf51ay6pZCj3+XlVCPmCKLDFpLj7QP+2heR+/n08WgS7Bve7JMkgubHOkwLzaTr+",
"/robots.txt": "sha384-ecOQzusX3in/IhiCS3OVe/lCOk5j8t0L3tCGM57ZnutJq8rNVX846mJIxNCl57wB",
"/sitemap.xml": "sha384-rWQi7Qqoz/lNZFLaYgnzKXn2BHGrHtTfTl4UrUnRczJypmeXqh3Aga755pwQcKYJ"
"/sitemap.xml": "sha384-YwFmhwZYycLnoPrKW6RbbxHUoJAtB0YBspN7CMayZ897d8eeiteZ3+/JWrWbawdi"
}
}

0 comments on commit b750bf8

Please sign in to comment.