Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Oct 9, 2023
1 parent 6b7e09a commit 31cb627
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 11 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"/><meta http-equiv="Permissions-Policy" content="interest-cohort=()"/><link rel="icon" href="/format/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="/format/magic.css?hL6TXJdzG/" integrity="sha384-hL6TXJdzG/fcaSNzABDqHDUb/WCFv0/yX6F7PSMTKd6ufwTeHxr6WXubO7NFwpsH" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/format/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/format/"><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>@magic/format</p><nav class="Menu"><ul><li><a href="/format/#install">install</a></li><li><a href="/format/#usage">usage</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://magic.github.io/">magic</a></div></div></footer></div></main><script src="/format/magic.js?y6+qEJEJmj" integrity="sha384-y6+qEJEJmju8CT+Xtapg9BdSlNU3zvt9CHd7lcKPvRGqOi6VyClgG5JX5i0AIJPN" crossorigin="anonymous" type="module"></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"/><meta http-equiv="Permissions-Policy" content="interest-cohort=()"/><link rel="icon" href="/format/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="/format/magic.css?fuYRy10jiI" integrity="sha384-fuYRy10jiIv65W7WfSmnIdUpn4j2LaceRHTeNaXLwvkt9QCfZ5jAv5cjjO3PIB1R" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/format/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/format/"><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>@magic/format</p><nav class="Menu"><ul><li><a href="/format/#install">install</a></li><li><a href="/format/#usage">usage</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://magic.github.io/">magic</a></div></div></footer></div></main><script src="/format/magic.js?WN28I6uI4B" integrity="sha384-WN28I6uI4BXUgrb4MHkQfKnACcP4s2JnF460965nAye/Dl7GKqT6nz9XpqWecO6u" crossorigin="anonymous" type="module"></script></body></html>
2 changes: 1 addition & 1 deletion docs/index.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"/><meta http-equiv="Permissions-Policy" content="interest-cohort=()"/><link rel="icon" href="/format/favicon.ico"/><title>@magic/format</title><meta name="description" content="run prettier and format your code."/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic/format"}</script><link rel="stylesheet" href="/format/magic.css?hL6TXJdzG/" integrity="sha384-hL6TXJdzG/fcaSNzABDqHDUb/WCFv0/yX6F7PSMTKd6ufwTeHxr6WXubO7NFwpsH" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/format/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/format/"><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>@magic/format</p><nav class="Menu"><ul><li><a href="/format/#install">install</a></li><li><a href="/format/#usage">usage</a></li></ul></nav></header><div class="Page" id="page"><h1>@magic/format</h1><p>run prettier and format your code.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic/format?color=blue" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><img src="https://img.shields.io/node/v/@magic/format?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><img src="https://img.shields.io/npm/l/@magic/format?color=blue" height="23" role="presentation" alt="" loading="lazy"/></li><li><a href="https://travis-ci.com/magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic/format/master" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://ci.appveyor.com/project/magic/format/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magic/format/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://coveralls.io/github/magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic/format/master.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li><li><a href="https://snyk.io/test/github/magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic/format.svg" height="23" role="presentation" alt="" loading="lazy"/></a></li></ul><h2 id="install">install</h2><p>be in a nodejs project.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> i --save-dev --save-exact @magic/format</code></pre></div><h2 id="usage">Usage</h2><h2 id="usage-npm">npm run scripts</h2><p>Add the @magic/test bin scripts to package.json</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">{</code><code class="line"> <span class="string">&quot;scripts&quot;</span>: {</code><code class="line"> <span class="string">&quot;format&quot;</span>: <span class="string">&quot;f -w&quot;</span>,</code><code class="line"> <span class="string">&quot;format:check&quot;</span>: <span class="string">&quot;f&quot;</span></code><code class="line"> },</code><code class="line"> <span class="string">&quot;devDependencies&quot;</span>: {</code><code class="line"> <span class="string">&quot;@magic/format&quot;</span>: <span class="string">&quot;0.0.1&quot;</span></code><code class="line"> }</code><code class="line">}</code></pre></div><p>then use the npm run scripts</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> run format</code><code class="line"><span class="keyword">npm</span> run format:check</code></pre></div><h3 id="usage-cli">cli</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// first <span class="keyword">install</span> globally</span></code><code class="line"><span class="keyword">npm</span> i -g @magic/format</code><code class="line"></code><code class="line"><span class="comment">// check formatting using prettier but <span class="keyword">do</span> not write</span></code><code class="line"><span class="comment">// prettier --list-different</span></code><code class="line">f</code><code class="line"></code><code class="line"><span class="comment">// format files using prettier</span></code><code class="line"><span class="comment">// prettier --write</span></code><code class="line">f -w</code></pre></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="/format/magic.js?y6+qEJEJmj" integrity="sha384-y6+qEJEJmju8CT+Xtapg9BdSlNU3zvt9CHd7lcKPvRGqOi6VyClgG5JX5i0AIJPN" crossorigin="anonymous" type="module"></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"/><meta http-equiv="Permissions-Policy" content="interest-cohort=()"/><link rel="icon" href="/format/favicon.ico"/><title>@magic/format</title><meta name="description" content="run prettier and format your code."/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic/format"}</script><link rel="stylesheet" href="/format/magic.css?fuYRy10jiI" integrity="sha384-fuYRy10jiIv65W7WfSmnIdUpn4j2LaceRHTeNaXLwvkt9QCfZ5jAv5cjjO3PIB1R" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/format/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/format/"><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>@magic/format</p><nav class="Menu"><ul><li><a href="/format/#install">install</a></li><li><a href="/format/#usage">usage</a></li></ul></nav></header><div class="Page" id="page"><h1>@magic/format</h1><p>run prettier and format your code.</p><ul class="GitBadges"><li><a href="https://www.npmjs.com/package/@magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/npm/v/@magic/format?color=blue" height="23" alt="" loading="lazy"/></a></li><li><img src="https://img.shields.io/node/v/@magic/format?color=blue" height="23" alt="" loading="lazy"/></li><li><img src="https://img.shields.io/npm/l/@magic/format?color=blue" height="23" alt="" loading="lazy"/></li><li><a href="https://travis-ci.com/magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/travis/com/magic/format/master" height="23" alt="" loading="lazy"/></a></li><li><a href="https://ci.appveyor.com/project/magic/format/branch/master" target="_blank" rel="noopener"><img src="https://img.shields.io/appveyor/ci/magic/format/master.svg" height="23" alt="" loading="lazy"/></a></li><li><a href="https://coveralls.io/github/magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/coveralls/github/magic/format/master.svg" height="23" alt="" loading="lazy"/></a></li><li><a href="https://snyk.io/test/github/magic/format" target="_blank" rel="noopener"><img src="https://img.shields.io/snyk/vulnerabilities/github/magic/format.svg" height="23" alt="" loading="lazy"/></a></li></ul><h2 id="install">install</h2><p>be in a nodejs project.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> i --save-dev --save-exact @magic/format</code></pre></div><h2 id="usage">Usage</h2><h2 id="usage-npm">npm run scripts</h2><p>Add the @magic/test bin scripts to package.json</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">{</code><code class="line"> <span class="string">&quot;scripts&quot;</span>: {</code><code class="line"> <span class="string">&quot;format&quot;</span>: <span class="string">&quot;f -w&quot;</span>,</code><code class="line"> <span class="string">&quot;format:check&quot;</span>: <span class="string">&quot;f&quot;</span></code><code class="line"> },</code><code class="line"> <span class="string">&quot;devDependencies&quot;</span>: {</code><code class="line"> <span class="string">&quot;@magic/format&quot;</span>: <span class="string">&quot;0.0.1&quot;</span></code><code class="line"> }</code><code class="line">}</code></pre></div><p>then use the npm run scripts</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> run format</code><code class="line"><span class="keyword">npm</span> run format:check</code></pre></div><h3 id="usage-cli">cli</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// first <span class="keyword">install</span> globally</span></code><code class="line"><span class="keyword">npm</span> i -g @magic/format</code><code class="line"></code><code class="line"><span class="comment">// check formatting using prettier but <span class="keyword">do</span> not write</span></code><code class="line"><span class="comment">// prettier --list-different</span></code><code class="line">f</code><code class="line"></code><code class="line"><span class="comment">// format files using prettier</span></code><code class="line"><span class="comment">// prettier --write</span></code><code class="line">f -w</code></pre></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="/format/magic.js?WN28I6uI4B" integrity="sha384-WN28I6uI4BXUgrb4MHkQfKnACcP4s2JnF460965nAye/Dl7GKqT6nz9XpqWecO6u" crossorigin="anonymous" type="module"></script></body></html>
Loading

0 comments on commit 31cb627

Please sign in to comment.