Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Jan 5, 2021
1 parent 64fd8e2 commit ac9a04d
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 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="/docs/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="/docs/magic.css?YNb6KjUMxQ" integrity="sha384-YNb6KjUMxQpmkbd9J3Gt+UXotGtPG8U5+AQ+zZwWTRPtVzVQ+i4SfGzYg9/6g4EI" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/docs/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/docs/"><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-themes/docs</p><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li><li><a href="/docs/#customize">customize</a></li></ul></nav></div></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="/docs/magic.js?wFf8Er/4Jy" integrity="sha384-wFf8Er/4JyNkEkv7iyTbvIm1bAwA4lxnti0MXvdHyxpxv+r7Xze17PFdWojzTeH4" 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="/docs/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="/docs/magic.css?YNb6KjUMxQ" integrity="sha384-YNb6KjUMxQpmkbd9J3Gt+UXotGtPG8U5+AQ+zZwWTRPtVzVQ+i4SfGzYg9/6g4EI" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/docs/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/docs/"><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-themes/docs</p><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li><li><a href="/docs/#customize">customize</a></li></ul></nav></div></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="/docs/magic.js?8Qz/Kz38cY" integrity="sha384-8Qz/Kz38cYeiLzyceXURPC9YuL8SyPDwsZIQN2Tsgngz2l4et/Izue/qiDtm6q/R" 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,3 +1,3 @@
<!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="/docs/favicon.ico"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website"}</script><link rel="stylesheet" href="/docs/magic.css?YNb6KjUMxQ" integrity="sha384-YNb6KjUMxQpmkbd9J3Gt+UXotGtPG8U5+AQ+zZwWTRPtVzVQ+i4SfGzYg9/6g4EI" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/docs/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><div><a class="Logo" href="/docs/"><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-themes/docs</p><nav class="Menu"><ul><li><a href="/docs/#installation">installation</a></li><li><a href="/docs/#usage">usage</a></li><li><a href="/docs/#customize">customize</a></li></ul></nav></div></header><div class="Page" id="page"><h1 id="magic-themesdocs">@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"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">npm</span> <span class="keyword">install</span> --save --save-exact @magic-themes/docs</code></pre></div><h2 id="usage">usage</h2><h3 id="require">require</h3><p>in /config.mjs, just require the theme.</p><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="comment">// /config.mjs</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"> THEME: <span class="string">&#39;docs&#39;</span>,</code><code class="line"></code><code class="line"> <span class="comment">// multiple themes can be used too:</span></code><code class="line"> THEME: [<span class="string">&#39;docs&#39;</span>, <span class="string">&#39;your-theme-name&#39;</span>],</code><code class="line">}</code></pre></div><h3 id="customize">customize</h3><p>you can customize and add any kind of style
create /assets/themes/docs/index.mjs, 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/index.mjs</span></code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> vars <span class="keyword">=&gt;</span> ({</code><code class="line"> body: {</code><code class="line"> color: vars.colors.orange[900],</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></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="/docs/magic.js?wFf8Er/4Jy" integrity="sha384-wFf8Er/4JyNkEkv7iyTbvIm1bAwA4lxnti0MXvdHyxpxv+r7Xze17PFdWojzTeH4" crossorigin="anonymous"></script></body></html>
create /assets/themes/docs/index.mjs, 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/index.mjs</span></code><code class="line"></code><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> vars <span class="keyword">=&gt;</span> ({</code><code class="line"> body: {</code><code class="line"> color: vars.colors.orange[900],</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></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="/docs/magic.js?8Qz/Kz38cY" integrity="sha384-8Qz/Kz38cYeiLzyceXURPC9YuL8SyPDwsZIQN2Tsgngz2l4et/Izue/qiDtm6q/R" crossorigin="anonymous"></script></body></html>

0 comments on commit ac9a04d

Please sign in to comment.