-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
15 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/gitbadges/favicon.ico"/><link rel="stylesheet" href="/gitbadges/magic.css"/></head><body><div id="magic"><div class="wrapper"><header class="main"><a class="logo-wrapper" href="/gitbadges/"><span class="logo-text">gitbadges</span></a><nav class="Menu"><ul><li><a href="/gitbadges/#installation">installation</a></li><li><a href="/gitbadges/#require">require</a></li><li><a href="/gitbadges/#usage">usage</a></li></ul></nav></header><div class="page"><div><h1>@magic-modules/gitbadges</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> GitBadges component. It shows a list of git badges for your projects.</p><h2 id="installation">installation</h2><p>installation is done using npm. for now, all magic modules are living on github and not on npm.</p><p>note the missing @ before magic-modules.</p><p>this is how we install npm modules from github.</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line">npm install magic-modules/gitbadges</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"><code class="line comment">// assets/index.js</code></code><code class="line"><span class="keyword">module</span>.<span class="keyword">exports</span> = {</code><code class="line"><code class="line comment"> // ..other <span class="keyword">exports</span></code></code><code class="line"> <span class="colon">GitBadges</span>: <span class="keyword">require</span>(<span class="string">'@magic-modules/gitbadges'</span>),</code><code class="line">}</code></pre></div><h2 id="usage">usage</h2><p>in a page/component, just pass the badge user/project string for those badges you want to show:</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line">GitBadges({</code><code class="line"><code class="line comment"> // show all badges,</code></code><code class="line"><code class="line comment"> // insert project into the various urls of the badges</code></code><code class="line"> <span class="colon">project</span>: <span class="string">'user/project'</span>,</code><code class="line"></code><code class="line"><code class="line comment"> // optional <span class="keyword">if</span> different to project above</code></code><code class="line"><code class="line comment"> // every one of <span class="keyword">this</span> arguments can be <span class="boolean">false</span> to hide a badge</code></code><code class="line"> <span class="colon">npm</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">travis</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">coveralls</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">appveyor</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">greenkeeper</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"></code><code class="line"><code class="line comment"> // optional, master is <span class="keyword">default</span> value</code></code><code class="line"> <span class="colon">branch</span>: <span class="string">'master'</span>,</code><code class="line">})</code></pre></div><p>renders</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/gitbadges.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-modules/gitbadges.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/jaeh/gitbadges/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/jaeh/gitbadges/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-modules/gitbadges/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/gitbadges.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-modules/gitbadges/badge.svg" role="presentation" alt=""/></a></li></ul></div></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="/gitbadges/magic.js"></script></body></html> | ||
| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/gitbadges/favicon.ico"/><link rel="stylesheet" href="/gitbadges/magic.css"/></head><body><div id="magic"><div class="wrapper"><header class="main"><a class="logo-wrapper" href="/gitbadges/"><span class="logo-text">gitbadges</span></a><nav class="Menu"><ul><li><a href="/gitbadges/#installation">installation</a></li><li><a href="/gitbadges/#require">require</a></li><li><a href="/gitbadges/#usage">usage</a></li></ul></nav></header><div class="page"><div><h1>@magic-modules/gitbadges</h1><p>this is the <a href="https://github.com/magic-modules" target="_blank" rel="noopener">@magic-modules</a> GitBadges component. It shows a list of git badges for your projects.</p><h2 id="installation">installation</h2><p>installation is done using npm. for now, all magic modules are living on github and not on npm.</p><p>note the missing @ before magic-modules.</p><p>this is how we install npm modules from github.</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line">npm install magic-modules/gitbadges</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">GitBadges</span>: <span class="keyword">require</span>(<span class="string">'@magic-modules/gitbadges'</span>),</code><code class="line">}</code></pre></div><h2 id="usage">usage</h2><p>in a page/component, just pass the badge user/project string for those badges you want to show:</p><div class="Pre light"><div class="menu"><button>dark</button><button>copy</button></div><pre><code class="line">GitBadges({</code><code class="line"><span class="comment"> // show all badges,</span></code><code class="line"><span class="comment"> // insert project into the various urls of the badges</span></code><code class="line"> <span class="colon">project</span>: <span class="string">'user/project'</span>,</code><code class="line"></code><code class="line"><span class="comment"> // optional <span class="keyword">if</span> different to project above</span></code><code class="line"><span class="comment"> // every one of <span class="keyword">this</span> arguments can be <span class="boolean">false</span> to hide a badge</span></code><code class="line"> <span class="colon">npm</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">travis</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">coveralls</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">appveyor</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"> <span class="colon">greenkeeper</span>: <span class="string">'user/project'</span> || <span class="boolean">false</span>,</code><code class="line"></code><code class="line"><span class="comment"> // optional, master is <span class="keyword">default</span> value</span></code><code class="line"> <span class="colon">branch</span>: <span class="string">'master'</span>,</code><code class="line">})</code></pre></div><p>renders</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic-modules/gitbadges.svg" role="presentation" alt=""/></a></li><li><a href="https://travis-ci.com/magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://travis-ci.com/magic-modules/gitbadges.svg?branch=master" role="presentation" alt=""/></a></li><li><a href="https://ci.appveyor.com/project/jaeh/gitbadges/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/jaeh/gitbadges/master.svg" role="presentation" alt=""/></a></li><li><a href="https://coveralls.io/github/magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://coveralls.io/repos/github/magic-modules/gitbadges/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/gitbadges.svg" role="presentation" alt=""/></a></li><li><a href="https://snyk.io/test/github/magic-modules/gitbadges" target="_blank" rel="noopener"><img src="https://snyk.io/test/github/magic-modules/gitbadges/badge.svg" role="presentation" alt=""/></a></li></ul></div></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="/gitbadges/magic.js"></script></body></html> |
Binary file not shown.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Binary file not shown.
Oops, something went wrong.