Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Dec 28, 2019
1 parent 9d00db6 commit de4bfab
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 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"/><link rel="stylesheet" href="/docs/magic.css?mF9vKm1lBS" integrity="sha384-mF9vKm1lBSWlTl5tb2kbWBGT2VE60zSYdj9Ewx3uJukWI2cntQtTWgardl563Gkp" crossorigin="anonymous"/><link rel="icon" href="/docs/favicon.ico"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website"}</script></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/docs/"><span>@magic-themes/docs</span></a><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li></ul></nav></header><div class="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="/docs/magic.js?bxMZXvApvf" integrity="sha384-bxMZXvApvfPfsmrZwQNtjZF78MKBSU7obWcPY6AFCj1kf8NthyfaILZTsN7FSlCC" crossorigin="anonymous"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="stylesheet" href="/docs/magic.css?mF9vKm1lBS" integrity="sha384-mF9vKm1lBSWlTl5tb2kbWBGT2VE60zSYdj9Ewx3uJukWI2cntQtTWgardl563Gkp" crossorigin="anonymous"/><link rel="icon" href="/docs/favicon.ico"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website"}</script></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/docs/"><span>@magic-themes/docs</span></a><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li></ul></nav></header><div class="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="/docs/magic.js?iiRZsjR6QH" integrity="sha384-iiRZsjR6QH1vTxqDJSwH3K4kVXs/mhHg7wrYaJ9jTcwXLSN7eLybzAFpda4mGmox" crossorigin="anonymous"></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"/><link rel="stylesheet" href="/docs/magic.css?mF9vKm1lBS" integrity="sha384-mF9vKm1lBSWlTl5tb2kbWBGT2VE60zSYdj9Ewx3uJukWI2cntQtTWgardl563Gkp" crossorigin="anonymous"/><link rel="icon" href="/docs/favicon.ico"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website"}</script></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/docs/"><span>@magic-themes/docs</span></a><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li></ul></nav></header><div class="Page"><div><h1>@magic-themes/docs</h1><p>this is the <a href="https://github.com/magic-themes" target="_blank" rel="noopener">@magic-themes</a> docs theme. It is being used as the documentation theme for most @magic packages.</p><h3 id="installation">installation</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">npm install magic-themes/docs</code></pre></div><h2 id="usage">usage</h2><h3 id="usage-require">require in config.js:</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// <span class="object">config</span>.<span class="property">mjs</span></span></code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"><span class="comment"> // ... other config</span></code><code class="line"> <span class="colon">THEME</span>: <span class="string">&#39;docs&#39;</span>,</code><code class="line">}</code></pre></div><h3 id="usage-customize">customize / overwrite</h3><p>you can customize and add any kind of style</p><p>create /assets/themes/docs/index.js, any css there will overwrite the theme css</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// /assets/themes/docs/<span class="object">index</span>.<span class="property">mjs</span></span></code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="colon">body</span>: {</code><code class="line"> <span class="colon">color</span>: <span class="string">&#39;orange&#39;</span>,</code><code class="line"> },</code><code class="line">}</code></pre></div><p>magic will then find and merge the themes automatically, just as it did on this page</p><button class="LightSwitch"></button></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="/docs/magic.js?bxMZXvApvf" integrity="sha384-bxMZXvApvfPfsmrZwQNtjZF78MKBSU7obWcPY6AFCj1kf8NthyfaILZTsN7FSlCC" crossorigin="anonymous"></script></body></html>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"/><link rel="stylesheet" href="/docs/magic.css?mF9vKm1lBS" integrity="sha384-mF9vKm1lBSWlTl5tb2kbWBGT2VE60zSYdj9Ewx3uJukWI2cntQtTWgardl563Gkp" crossorigin="anonymous"/><link rel="icon" href="/docs/favicon.ico"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website"}</script></head><body><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/docs/"><span>@magic-themes/docs</span></a><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li></ul></nav></header><div class="Page"><div><h1>@magic-themes/docs</h1><p>this is the <a href="https://github.com/magic-themes" target="_blank" rel="noopener">@magic-themes</a> docs theme. It is being used as the documentation theme for most @magic packages.</p><h3 id="installation">installation</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line">npm install magic-themes/docs</code></pre></div><h2 id="usage">usage</h2><h3 id="usage-require">require in config.js:</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// <span class="object">config</span>.<span class="property">mjs</span></span></code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"><span class="comment"> // ... other config</span></code><code class="line"> <span class="colon">THEME</span>: <span class="string">&#39;docs&#39;</span>,</code><code class="line">}</code></pre></div><h3 id="usage-customize">customize / overwrite</h3><p>you can customize and add any kind of style</p><p>create /assets/themes/docs/index.js, any css there will overwrite the theme css</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// /assets/themes/docs/<span class="object">index</span>.<span class="property">mjs</span></span></code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="colon">body</span>: {</code><code class="line"> <span class="colon">color</span>: <span class="string">&#39;orange&#39;</span>,</code><code class="line"> },</code><code class="line">}</code></pre></div><p>magic will then find and merge the themes automatically, just as it did on this page</p><button class="LightSwitch"></button></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="/docs/magic.js?iiRZsjR6QH" integrity="sha384-iiRZsjR6QH1vTxqDJSwH3K4kVXs/mhHg7wrYaJ9jTcwXLSN7eLybzAFpda4mGmox" crossorigin="anonymous"></script></body></html>
Loading

0 comments on commit de4bfab

Please sign in to comment.