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 5d5a030 commit 110b07c
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
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="/accordion/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="/accordion/magic.css?BLkNKe3KGD" integrity="sha384-BLkNKe3KGDA6+UT20+0dX9a6/AfiE2X3MEtEkAaRbbRM9yDqTzQFceWe1RYnvEmT" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/accordion/"><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>Accordion</p><nav class="Menu"><ul><li><a href="/accordion/#installation">installation</a></li><li><a href="/accordion/#usage">usage</a></li><li><a href="/accordion/#demo">demo</a></li><li><a href="/accordion/#css">css</a></li><li><a href="/accordion/#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="/accordion/magic.js?MqBHx5lMor" integrity="sha384-MqBHx5lMorPAvTfFSXYSnJtnbexGsEg2/rKtBfGVeb/LEg3E8WfUeR3aRJO7vGtg" 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="/accordion/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="/accordion/magic.css?/A8Nf/T6Xj" integrity="sha384-/A8Nf/T6Xjl3v/GjJ00p2GFC675ptIlPQ6yjcSb1T80B19D12t6JtXr89FKd1blA" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/accordion/"><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>Accordion</p><nav class="Menu"><ul><li><a href="/accordion/#installation">installation</a></li><li><a href="/accordion/#usage">usage</a></li><li><a href="/accordion/#demo">demo</a></li><li><a href="/accordion/#css">css</a></li><li><a href="/accordion/#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="/accordion/magic.js?9SVm4RG4Do" integrity="sha384-9SVm4RG4DoZ36ow7YjCgeQ5WxlULZFAh/Fjp0ZIZVR02Sz28DRaBEGn6w9C3Go+A" 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,5 +1,5 @@
<!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="/accordion/favicon.ico"/><title>@magic-modules/accordion</title><meta name="description" content="shows / hides items in a vertical accordion"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/accordion"}</script><link rel="stylesheet" href="/accordion/magic.css?BLkNKe3KGD" integrity="sha384-BLkNKe3KGDA6+UT20+0dX9a6/AfiE2X3MEtEkAaRbbRM9yDqTzQFceWe1RYnvEmT" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/accordion/"><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>Accordion</p><nav class="Menu"><ul><li><a href="/accordion/#installation">installation</a></li><li><a href="/accordion/#usage">usage</a></li><li><a href="/accordion/#demo">demo</a></li><li><a href="/accordion/#css">css</a></li><li><a href="/accordion/#source">source</a></li></ul></nav></div></header><div class="Page" id="page"><h1 id="magic-modulesaccordion">@magic-modules/accordion</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> Accordion component.</p><p>shows / hides items in a vertical accordion</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/accordion?color=blue" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><img src="https://img.shields.io/node/v/@magic-modules/accordion?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><img src="https://img.shields.io/npm/l/@magic-modules/accordion?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><a href="https://travis-ci.com/magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic-modules/accordion/master" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/accordion/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/accordion/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://coveralls.io/github/magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic-modules/accordion/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://snyk.io/test/github/magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic-modules/accordion.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li></ul><h2 id="installation">installation</h2><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> <span class="keyword">install</span> @magic-modules/accordion</code></pre></div><h2 id="usage">usage</h2><p>in a page or Component.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;Accordion</code><code class="line"> <span class="state">state</span></code><code class="line"> key=<span class="string">&quot;about&quot;</span></code><code class="line"> items=&quot;[</code><code class="line"> { title: <span class="string">&#39;title text: &#39;</span>content&#39; },</code><code class="line"> { title: <span class="string">&#39;title 2 text: &#39;</span>content 2&#39; },</code><code class="line"> {</code><code class="line"> title: &#39;title 3</code><code class="line"> text: [</code><code class="line"> p(<span class="string">&#39;content&#39;</span>),</code><code class="line"> p(<span class="string">&#39;can also be an&#39;</span>),</code><code class="line"> p([<span class="string">&#39;array &#39;</span> of <span class="string">&#39; modules&#39;</span>]),</code><code class="line"> Link({ to: <span class="string">&#39;https://magic.github.io&#39;</span> }, <span class="string">&#39;magic.github.io&#39;</span>),</code><code class="line"> ],</code><code class="line"> },</code><code class="line"> ]&quot;</code><code class="line"> title=<span class="string">&quot;optional title&quot;</span>&gt;</code><code class="line">&lt;/Accordion&gt;</code></pre></div><h2 id="demo">demo</h2><p>the example above renders</p><div class="Accordion about"><h3>optional title</h3><ul><div class="AccordionItem"><h4>title</h4><div class="content">content</div></div><div class="AccordionItem"><h4>title 2</h4><div class="content">content 2</div></div></ul></div><h2 id="css">css</h2><p>by default, css is minimal. to adapt the styles for your theme,
<!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="/accordion/favicon.ico"/><title>@magic-modules/accordion</title><meta name="description" content="shows / hides items in a vertical accordion"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic-modules/accordion"}</script><link rel="stylesheet" href="/accordion/magic.css?/A8Nf/T6Xj" integrity="sha384-/A8Nf/T6Xjl3v/GjJ00p2GFC675ptIlPQ6yjcSb1T80B19D12t6JtXr89FKd1blA" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/accordion/"><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>Accordion</p><nav class="Menu"><ul><li><a href="/accordion/#installation">installation</a></li><li><a href="/accordion/#usage">usage</a></li><li><a href="/accordion/#demo">demo</a></li><li><a href="/accordion/#css">css</a></li><li><a href="/accordion/#source">source</a></li></ul></nav></div></header><div class="Page" id="page"><h1 id="magic-modulesaccordion">@magic-modules/accordion</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> Accordion component.</p><p>shows / hides items in a vertical accordion</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/accordion?color=blue" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><img src="https://img.shields.io/node/v/@magic-modules/accordion?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><img src="https://img.shields.io/npm/l/@magic-modules/accordion?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><a href="https://travis-ci.com/magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic-modules/accordion/master" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/accordion/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/accordion/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://coveralls.io/github/magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic-modules/accordion/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://snyk.io/test/github/magic-modules/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic-modules/accordion.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li></ul><h2 id="installation">installation</h2><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> <span class="keyword">install</span> @magic-modules/accordion</code></pre></div><h2 id="usage">usage</h2><p>in a page or Component.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">&lt;Accordion</code><code class="line"> <span class="state">state</span></code><code class="line"> key=<span class="string">&quot;about&quot;</span></code><code class="line"> items=&quot;[</code><code class="line"> { title: <span class="string">&#39;title text: &#39;</span>content&#39; },</code><code class="line"> { title: <span class="string">&#39;title 2 text: &#39;</span>content 2&#39; },</code><code class="line"> {</code><code class="line"> title: &#39;title 3</code><code class="line"> text: [</code><code class="line"> p(<span class="string">&#39;content&#39;</span>),</code><code class="line"> p(<span class="string">&#39;can also be an&#39;</span>),</code><code class="line"> p([<span class="string">&#39;array &#39;</span> of <span class="string">&#39; modules&#39;</span>]),</code><code class="line"> Link({ to: <span class="string">&#39;https://magic.github.io&#39;</span> }, <span class="string">&#39;magic.github.io&#39;</span>),</code><code class="line"> ],</code><code class="line"> },</code><code class="line"> ]&quot;</code><code class="line"> title=<span class="string">&quot;optional title&quot;</span>&gt;</code><code class="line">&lt;/Accordion&gt;</code></pre></div><h2 id="demo">demo</h2><p>the example above renders</p><div class="Accordion about"><h3>optional title</h3><ul><div class="AccordionItem"><h4>title</h4><div class="content">content</div></div><div class="AccordionItem"><h4>title 2</h4><div class="content">content 2</div></div></ul></div><h2 id="css">css</h2><p>by default, css is minimal. to adapt the styles for your theme,
add (and change) the following object to /assets/theme/{THEME_NAME}/index.mjs</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="string">&#39;.Accordion&#39;</span>: {</code><code class="line"> h3: {}, <span class="comment">// main title</span></code><code class="line"> <span class="string">&#39;.AccordionItem&#39;</span>: {</code><code class="line"> h4: {}, <span class="comment">// item title</span></code><code class="line"></code><code class="line"> <span class="string">&#39;.content&#39;</span>: {}, <span class="comment">// item content</span></code><code class="line"></code><code class="line"> <span class="string">&#39;&amp;.open&#39;</span>: {</code><code class="line"> <span class="string">&#39;.content&#39;</span>: {}, <span class="comment">// item content <span class="keyword">if</span> opened</span></code><code class="line"> },</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/accordion/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="/accordion/magic.js?MqBHx5lMor" integrity="sha384-MqBHx5lMorPAvTfFSXYSnJtnbexGsEg2/rKtBfGVeb/LEg3E8WfUeR3aRJO7vGtg" 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="/accordion/magic.js?9SVm4RG4Do" integrity="sha384-9SVm4RG4DoZ36ow7YjCgeQ5WxlULZFAh/Fjp0ZIZVR02Sz28DRaBEGn6w9C3Go+A" crossorigin="anonymous"></script></body></html>
Loading

0 comments on commit 110b07c

Please sign in to comment.