Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed May 4, 2019
1 parent d63156d commit c3f445d
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 27 deletions.
26 changes: 1 addition & 25 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/client-list/favicon.ico"/><title>@magic-modules/client-list</title><meta name="description" content="shows a list of all @magic-modules with gitbadges and urls to the docs"/><link rel="stylesheet" href="/client-list/magic.css"/></head><body><div id="magic"><div class="wrapper"><header class="main"><a class="logo-wrapper" href="/client-list/"><span class="logo-text">ClientList</span></a><nav class="Menu"><ul><li><a href="/client-list/#installation">installation</a></li><li><a href="/client-list/#require">require</a></li><li><a href="/client-list/#usage">usage</a></li><li><a href="/client-list/#demo">demo</a></li><li><a href="/client-list/#source">source</a></li></ul></nav></header><div class="page"><h1>@magic-modules/client-list</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> ClientList component. shows a list of all @magic-modules with gitbadges and urls to the docs</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/client-list" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/client-list.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-modules/client-list" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-modules/client-list.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/client-list/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/client-list/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-modules/client-list" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-modules/client-list/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/client-list.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-modules/client-list" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-modules/client-list/badge.svg" role="presentation" alt=""/></a></li></ul><h2 id="installation">installation</h2><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line">npm install magic-modules/client-list</code></pre></div><h2 id="require">require</h2><p>first add the component to the assets</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line"><span class="comment">// assets/<span class="object">index</span>.<span class="property">js</span></span></code><code class="line"><span class="keyword">module</span>.<span class="keyword">exports</span> = {</code><code class="line"><span class="comment"> // ..other <span class="keyword">exports</span></span></code><code class="line"> <span class="colon">ClientList</span>: <span class="keyword">require</span>(<span class="string">&#39;@magic-modules/client-list&#39;</span>),</code><code class="line">}</code></pre></div><h2 id="usage">usage</h2><p>in a page or component</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line"><span class="keyword">module</span>.<span class="keyword">exports</span> = () =&gt; [ClientList]</code></pre></div><h2 id="demo">demo</h2><p>this is what it looks like</p><div class="GitList" id="magic-client"><h2><a href="https://magic-client.github.io" target="_blank" rel="noopener">@magic-client libraries</a></h2><div class="description">below is a collection of the available @magic client libraries.</div><ul id="magic-client" org="magic-client" header="(_, actions) =&gt; {
const { href, text, nofollow, noreferrer, onclick, ...props } = p
to = to || href || &#39;&#39;
props.href = to
if (to &amp;&amp; to.startsWith(&#39;/&#39;) &amp;&amp; !to.startsWith(`//`)) {
props.onclick = e =&gt; {
if (onclick) {
onclick({ e, to })
}
actions.go({ e, to })
}
} else {
props.target = &#39;_blank&#39;
props.rel = &#39;noopener&#39;
if (nofollow) {
props.rel += &#39; nofollow&#39;
}
if (noreferrer) {
props.rel += &#39; noreferrer&#39;
}
}
return a(props, [text, children])
}" desc="below is a collection of the available @magic client libraries." items="[object Object],[object Object]" url="/client-list/" root="/client-list/" title="@magic-modules/client-list" description="shows a list of all @magic-modules with gitbadges and urls to the docs" logotext="ClientList" menu="[object Object],[object Object],[object Object],[object Object],[object Object]" pre="[object Object]"><li id="magic-client-item-magic-client-json" class="GitListItem"><h3><a href="https://github.com/magic-client/json" target="_blank" rel="noopener">@magic-client/json</a></h3><p>the @magic-client/json module parses and stringifies json. it will also return errors instead of throwing them.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-client/json" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-client/json.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-client/json" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-client/json.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicclient/json/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicclient/json/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-client/json" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-client/json/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-client/json.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-client/json" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-client/json/badge.svg" role="presentation" alt=""/></a></li></ul><p><a href="https://magic-client.github.io/json" target="_blank" rel="noopener">docs / demo</a></p></li><li id="magic-client-item-magic-client-is" class="GitListItem"><h3><a href="https://github.com/magic-client/is" target="_blank" rel="noopener">@magic-client/is</a></h3><p>the @magic-client/is module unifies the javascript type testing apis.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-client/is" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-client/is.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-client/is" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-client/is.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicclient/is/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicclient/is/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-client/is" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-client/is/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-client/is.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-client/is" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-client/is/badge.svg" role="presentation" alt=""/></a></li></ul><p><a href="https://magic-client.github.io/is" target="_blank" rel="noopener">docs / demo</a></p></li></ul></div><h2 id="source">source</h2><p>the source for this page is in the <a href="https://github.com/magic-modules/client-list/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="main"><div class="wrapper">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></footer></div></div><script src="/client-list/magic.js"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/client-list/favicon.ico"/><title>@magic-modules/client-list</title><meta name="description" content="shows a list of all @magic-modules with gitbadges and urls to the docs"/><link rel="stylesheet" href="/client-list/magic.css"/></head><body><div id="magic"><div class="wrapper"><header class="main"><a class="logo-wrapper" href="/client-list/"><span class="logo-text">ClientList</span></a><nav class="Menu"><ul><li><a href="/client-list/#installation">installation</a></li><li><a href="/client-list/#require">require</a></li><li><a href="/client-list/#usage">usage</a></li><li><a href="/client-list/#demo">demo</a></li><li><a href="/client-list/#source">source</a></li></ul></nav></header><div class="page"><h1>@magic-modules/client-list</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> ClientList component. shows a list of all @magic-modules with gitbadges and urls to the docs</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/client-list" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/client-list.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-modules/client-list" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-modules/client-list.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicmodules/client-list/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicmodules/client-list/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-modules/client-list" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-modules/client-list/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-modules/client-list.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-modules/client-list" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-modules/client-list/badge.svg" role="presentation" alt=""/></a></li></ul><h2 id="installation">installation</h2><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line">npm install magic-modules/client-list</code></pre></div><h2 id="require">require</h2><p>first add the component to the assets</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line"><span class="comment">// assets/<span class="object">index</span>.<span class="property">js</span></span></code><code class="line"><span class="keyword">module</span>.<span class="keyword">exports</span> = {</code><code class="line"><span class="comment"> // ..other <span class="keyword">exports</span></span></code><code class="line"> <span class="colon">ClientList</span>: <span class="keyword">require</span>(<span class="string">&#39;@magic-modules/client-list&#39;</span>),</code><code class="line">}</code></pre></div><h2 id="usage">usage</h2><p>in a page or component</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line"><span class="keyword">module</span>.<span class="keyword">exports</span> = () =&gt; [ClientList]</code></pre></div><h2 id="demo">demo</h2><p>this is what it looks like</p><div class="GitList" id="magic-client"><h2><a href="https://magic-client.github.io" target="_blank" rel="noopener">@magic-client libraries</a></h2><div class="description">below is a collection of the available @magic client libraries.</div><ul id="magic-client-list"><li id="magic-client-json" class="GitListItem"><h3><a href="https://github.com/magic-client/json" target="_blank" rel="noopener">@magic-client/json</a></h3><p>the @magic-client/json module parses and stringifies json. it also returns errors instead of throwing them.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-client/json" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-client/json.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-client/json" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-client/json.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicclient/json/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicclient/json/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-client/json" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-client/json/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-client/json.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-client/json" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-client/json/badge.svg" role="presentation" alt=""/></a></li></ul><a href="https://magic-client.github.io/json" target="_blank" rel="noopener">docs / demo</a></li><li id="magic-client-is" class="GitListItem"><h3><a href="https://github.com/magic-client/is" target="_blank" rel="noopener">@magic-client/is</a></h3><p>the @magic-client/is module unifies the javascript type testing apis.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-client/is" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-client/is.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-client/is" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-client/is.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicclient/is/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicclient/is/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-client/is" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-client/is/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-client/is.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-client/is" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-client/is/badge.svg" role="presentation" alt=""/></a></li></ul><a href="https://magic-client.github.io/is" target="_blank" rel="noopener">docs / demo</a></li><li id="magic-client-uri" class="GitListItem"><h3><a href="https://github.com/magic-client/uri" target="_blank" rel="noopener">@magic-client/uri</a></h3><p>the @magic-client/uri module encodes objects to uri strings and decodes uri strings to objects.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-client/uri" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-client/uri.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-client/uri" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-client/uri.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/magicclient/uri/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magicclient/uri/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-client/uri" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-client/uri/badge.svg" role="presentation" alt=""/></a></li><li><a href="https://greenkeeper.io" target="_blank" rel="noopener"><img src="https://badges.greenkeeper.io/magic-client/uri.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-client/uri" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-client/uri/badge.svg" role="presentation" alt=""/></a></li></ul><a href="https://magic-client.github.io/uri" target="_blank" rel="noopener">docs / demo</a></li></ul></div><h2 id="source">source</h2><p>the source for this page is in the <a href="https://github.com/magic-modules/client-list/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="main"><div class="wrapper">made with a few bits of <a target="_blank" rel="noopener" href="https://github.com/magic/core">magic</a></div></footer></div></div><script src="/client-list/magic.js"></script></body></html>
Binary file modified docs/index.html.gz
View file
Binary file not shown.
Loading

0 comments on commit c3f445d

Please sign in to comment.