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 7, 2020
1 parent ea3b488 commit 0493ad2
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="/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?BjaNPpm/LI" integrity="sha384-BjaNPpm/LIlRHsy3Q8kC46lX3fBHkjnddKORnKfTVjGhcHnuokvJL17yhNhnnR+B" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/accordion/"><span>Accordion</span></a><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></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="/accordion/magic.js?4O91ViO3Uc" integrity="sha384-4O91ViO3Uc0dVXZUjJzP7GVvoIeTBGS9ZveTtLVpxt8kJlgkCs5yF+qbSKcH+e3u" 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>@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?IJO9EbmDQ1" integrity="sha384-IJO9EbmDQ1877WMkN/g3oVSk0evDTPSbF+xzjnHkYZ/RaaOyIw+gV+Jfz0/3b9Cf" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/accordion/"><span>Accordion</span></a><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></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="/accordion/magic.js?9/GSUZ4yJQ" integrity="sha384-9/GSUZ4yJQ23TbmUM8X3UCnWnAFdPzYoMhgaHR1Tt9inV+V4v9xez4NRRd5TvVK7" 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?BjaNPpm/LI" integrity="sha384-BjaNPpm/LIlRHsy3Q8kC46lX3fBHkjnddKORnKfTVjGhcHnuokvJL17yhNhnnR+B" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/accordion/"><span>Accordion</span></a><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></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.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/accordion" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic-modules/accordion/master" role="presentation" alt=""/></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" role="presentation" alt=""/></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" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/accordion.svg" role="presentation" alt=""/></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" 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/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"> { <span class="colon">title</span>: <span class="string">&#39;title <span class="colon">text</span>: &#39;</span>content&#39; },</code><code class="line"> { <span class="colon">title</span>: <span class="string">&#39;title 2 <span class="colon">text</span>: &#39;</span>content 2&#39; },</code><code class="line"> {</code><code class="line"> <span class="colon">title</span>: &#39;title 3</code><code class="line"> <span class="colon">text</span>: [</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({ <span class="colon">to</span>: &#39;<span class="colon">https</span>:<span class="comment">//<span class="object">magic</span>.<span class="property">github</span>.<span class="property">io</span>&#39; }, <span class="string">&#39;<span class="object">magic</span>.<span class="property">github</span>.<span class="property">io</span>&#39;</span>), </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?IJO9EbmDQ1" integrity="sha384-IJO9EbmDQ1877WMkN/g3oVSk0evDTPSbF+xzjnHkYZ/RaaOyIw+gV+Jfz0/3b9Cf" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/accordion/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/accordion/"><span>Accordion</span></a><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></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"></a><img src="https://img.shields.io/npm/v/@magic-modules/accordion.svg" height="23" role="presentation" alt=""/></li><li><img src="https://img.shields.io/node/v/@magic/core" height="23" role="presentation" alt=""/></li><li><a href="https://travis-ci.com/magic-modules/accordion" target="_blank" rel="noopener"></a><img src="https://img.shields.io/travis/com/magic-modules/accordion/master" height="23" role="presentation" alt=""/></li><li><a href="https://ci.appveyor.com/project/magicmodules/accordion/branch/master" target="_blank" rel="noopener"></a><img src="https://img.shields.io/appveyor/ci/magicmodules/accordion/master.svg" height="23" role="presentation" alt=""/></li><li><a href="https://coveralls.io/github/magic-modules/accordion" target="_blank" rel="noopener"></a><img src="https://img.shields.io/coveralls/github/magic-modules/accordion/master.svg" height="23" role="presentation" alt=""/></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"></a><img src="https://badges.greenkeeper.io/magic-modules/accordion.svg" height="23" role="presentation" alt=""/></li><li><a href="https://snyk.io/test/github/magic-modules/accordion" target="_blank" rel="noopener"></a><img src="https://img.shields.io/snyk/vulnerabilities/github/magic-modules/accordion.svg" height="23" role="presentation" alt=""/></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/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"> { <span class="colon">title</span>: <span class="string">&#39;title <span class="colon">text</span>: &#39;</span>content&#39; },</code><code class="line"> { <span class="colon">title</span>: <span class="string">&#39;title 2 <span class="colon">text</span>: &#39;</span>content 2&#39; },</code><code class="line"> {</code><code class="line"> <span class="colon">title</span>: &#39;title 3</code><code class="line"> <span class="colon">text</span>: [</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({ <span class="colon">to</span>: &#39;<span class="colon">https</span>:<span class="comment">//<span class="object">magic</span>.<span class="property">github</span>.<span class="property">io</span>&#39; }, <span class="string">&#39;<span class="object">magic</span>.<span class="property">github</span>.<span class="property">io</span>&#39;</span>), </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"> <span class="colon">h3</span>: {}, <span class="comment">// main title </span></code><code class="line"> <span class="string">&#39;.AccordionItem&#39;</span>: {</code><code class="line"> <span class="colon">h4</span>: {}, <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://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/accordion/magic.js?4O91ViO3Uc" integrity="sha384-4O91ViO3Uc0dVXZUjJzP7GVvoIeTBGS9ZveTtLVpxt8kJlgkCs5yF+qbSKcH+e3u" 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://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/accordion/magic.js?9/GSUZ4yJQ" integrity="sha384-9/GSUZ4yJQ23TbmUM8X3UCnWnAFdPzYoMhgaHR1Tt9inV+V4v9xez4NRRd5TvVK7" crossorigin="anonymous"></script></body></html>
Loading

0 comments on commit 0493ad2

Please sign in to comment.