Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
@jaeh
jaeh committed Mar 1, 2020
1 parent c9e53ff commit 9f4aa9c
Show file tree
Hide file tree
Showing 18 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
View file
@@ -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="/core/favicon.ico"/><title>@magic/core documentation</title><meta name="twitter:image" property="og:image" content="https://magic.github.io/core/core/logo.png"/><meta name="twitter:card" content="summary_large_image"/><meta name="author" content="Jascha Ehrenreich"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic/core documentation","url":"https://magic.github.io/core","about":"@magic framework core.","image":"https://magic.github.io/core/core/logo.png","author":{"@type":"person","name":"Jascha Ehrenreich","jobTitle":"Technomancer","image":"https:/jaeh.at/img/jascha.ehrenreich.jpg","url":"https://jaeh.at"}}</script><link rel="stylesheet" href="/core/magic.css?AuBbOOGV8V" integrity="sha384-AuBbOOGV8V7qwYuRRjL5HCXKKhRj29IGC4ARqET5FICjYTDqs0g9AL85rr8xI53/" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/core/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/core/"><img src="/core/logo.png" role="presentation" alt=""/><span>@magic</span></a><nav class="Menu"><ul><li><a href="/core/concepts/">concepts</a></li><li><a href="/core/files/">files &amp; directories</a></li><li><a href="/core/modules/">modules</a></li><li><a href="/core/themes/">themes</a></li><li><a href="/core/libraries/">libraries</a></li><li><a href="/core/news/">news</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://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/core/magic.js?aWIROZ5161" integrity="sha384-aWIROZ5161nRWBO7FGm5kenNt8/yAW0dvC/FQzKipxTvofcxvgA5c+g91xoMN1AP" 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="/core/favicon.ico"/><title>@magic/core documentation</title><meta name="twitter:image" property="og:image" content="https://magic.github.io/core/core/logo.png"/><meta name="twitter:card" content="summary_large_image"/><meta name="description" content="@magic/core documentation. tells you why, how and when to use @magic. also provides an overview of all @magic functionality this ecosystem provides."/><meta name="author" content="Jascha Ehrenreich"/><script type="application/ld+json">{"@context":"http://schema.org","@type":"website","name":"@magic/core documentation","url":"https://magic.github.io/core","about":"@magic framework core.","image":"https://magic.github.io/core/core/logo.png","author":{"@type":"person","name":"Jascha Ehrenreich","jobTitle":"Technomancer","image":"https:/jaeh.at/img/jascha.ehrenreich.jpg","url":"https://jaeh.at"}}</script><link rel="stylesheet" href="/core/magic.css?AuBbOOGV8V" integrity="sha384-AuBbOOGV8V7qwYuRRjL5HCXKKhRj29IGC4ARqET5FICjYTDqs0g9AL85rr8xI53/" crossorigin="anonymous"/></head><body><a class="SkipLink" href="/core/#page">Skip to Content</a><main id="Magic"><div class="Wrapper"><header class="Header"><a class="Logo" href="/core/"><img src="/core/logo.png" role="presentation" alt=""/><span>@magic</span></a><nav class="Menu"><ul><li><a href="/core/concepts/">concepts</a></li><li><a href="/core/files/">files &amp; directories</a></li><li><a href="/core/modules/">modules</a></li><li><a href="/core/themes/">themes</a></li><li><a href="/core/libraries/">libraries</a></li><li><a href="/core/news/">news</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://github.com/magic/core">magic</a></div></div></footer></div></main><script src="/core/magic.js?2Xn8S9cURI" integrity="sha384-2Xn8S9cURInobIW9YTRATwcQAhpUqrAR39fH2cBm9Aml4zQ794snEdOQ0o/GoOgA" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/concepts/index.html
View file
Expand Up @@ -11,4 +11,4 @@
you can define functions that get transpiled into serverside lambdas.
server side lambdas will be available for GET and/or POST requests.</p><p>the server side function signature is (req, res) =&gt; {},
as it is in most nodejs http servers,
with the addition of req.body being async =&gt; awaited before execution of the lambda.</p></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="/core/magic.js?aWIROZ5161" integrity="sha384-aWIROZ5161nRWBO7FGm5kenNt8/yAW0dvC/FQzKipxTvofcxvgA5c+g91xoMN1AP" crossorigin="anonymous"></script></body></html>
with the addition of req.body being async =&gt; awaited before execution of the lambda.</p></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="/core/magic.js?2Xn8S9cURI" integrity="sha384-2Xn8S9cURInobIW9YTRATwcQAhpUqrAR39fH2cBm9Aml4zQ794snEdOQ0o/GoOgA" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/files/index.html
View file
Expand Up @@ -8,4 +8,4 @@
<a href="https://github.com/jaeh/node-zopfli-es" target="_blank" rel="noopener">node-zopfli-es</a>
(if it is installed)</p><h2 id="themes">/assets/themes</h2><p>the themes directory contains... themes.</p><p>a magic theme is an object of css rules, see
<a href="https://github.com/magic/css/" target="_blank" rel="noopener">@magic/css</a>
for more examples and documentation.</p><h3 id="themes-example">example theme</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="string">&#39;body&#39;</span>: {</code><code class="line"> <span class="colon">color</span>: <span class="string">&#39;blue&#39;</span>,</code><code class="line"> },</code><code class="line">}</code></pre></div><h2 id="app">/assets/app.mjs</h2><p>the /app.mjs file allows you to set global state, actions, and styles</p><h3 id="app-example">example /app.mjs</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="state">state</span>: {</code><code class="line"> <span class="colon">globalStateVar</span>: <span class="string">&#39;globally available&#39;</span>,</code><code class="line"> },</code><code class="line"> <span class="actions">actions</span>: {</code><code class="line"> <span class="colon">globalAction</span>: () =&gt; ({ <span class="colon">globalStateVar</span>: <span class="string">&#39;<span class="object">overwritten</span>.&#39;</span> }),</code><code class="line"> },</code><code class="line"> <span class="colon">style</span>: {</code><code class="line"> <span class="string">&#39;body&#39;</span>: {</code><code class="line"> <span class="colon">color</span>: <span class="string">&#39;green&#39;</span>,</code><code class="line"> },</code><code class="line"> },</code><code class="line">}</code></pre></div><h2 id="config">/config.mjs</h2><p>the /config.mjs file allows you to set various aspects of your app</p><h3 id="config-example">example /config.mjs</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="colon">ROOT</span>: <span class="string">&#39;example&#39;</span>,</code><code class="line"> <span class="colon">THEME</span>: <span class="string">&#39;blue&#39;</span>,</code><code class="line"> <span class="colon">WEB_ROOT</span>: <span class="string">&#39;/core/&#39;</span>,</code><code class="line"></code><code class="line"><span class="comment"> // <span class="keyword">this</span> option adds the</span></code><code class="line"><span class="comment"> // <span class="string">&#39;X-Clacks-Overhead&#39;</span>, <span class="string">&#39;GNU Terry Pratchet&#39;</span></span></code><code class="line"><span class="comment"> // http header</span></code><code class="line"><span class="comment"> // see http://www.gnuterrypratchett.com/</span></code><code class="line"> <span class="colon">FOR_DEATH_CAN_NOT_HAVE_HIM</span>: <span class="boolean">true</span>,</code><code class="line"></code><code class="line"><span class="comment"> // <span class="keyword">default</span> CLIENT_LIB_NAME, overwrite to change names of transpiled css and js files</span></code><code class="line"> <span class="colon">CLIENT_LIB_NAME</span>: <span class="string">&#39;magic&#39;</span>,</code><code class="line">}</code></pre></div><a href="https://github.com/magic/core/blob/master/src/modules/Menu.mjs" target="_blank" rel="noopener">Menu.mjs on github</a></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="/core/magic.js?aWIROZ5161" integrity="sha384-aWIROZ5161nRWBO7FGm5kenNt8/yAW0dvC/FQzKipxTvofcxvgA5c+g91xoMN1AP" crossorigin="anonymous"></script></body></html>
for more examples and documentation.</p><h3 id="themes-example">example theme</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="string">&#39;body&#39;</span>: {</code><code class="line"> <span class="colon">color</span>: <span class="string">&#39;blue&#39;</span>,</code><code class="line"> },</code><code class="line">}</code></pre></div><h2 id="app">/assets/app.mjs</h2><p>the /app.mjs file allows you to set global state, actions, and styles</p><h3 id="app-example">example /app.mjs</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="state">state</span>: {</code><code class="line"> <span class="colon">globalStateVar</span>: <span class="string">&#39;globally available&#39;</span>,</code><code class="line"> },</code><code class="line"> <span class="actions">actions</span>: {</code><code class="line"> <span class="colon">globalAction</span>: () =&gt; ({ <span class="colon">globalStateVar</span>: <span class="string">&#39;<span class="object">overwritten</span>.&#39;</span> }),</code><code class="line"> },</code><code class="line"> <span class="colon">style</span>: {</code><code class="line"> <span class="string">&#39;body&#39;</span>: {</code><code class="line"> <span class="colon">color</span>: <span class="string">&#39;green&#39;</span>,</code><code class="line"> },</code><code class="line"> },</code><code class="line">}</code></pre></div><h2 id="config">/config.mjs</h2><p>the /config.mjs file allows you to set various aspects of your app</p><h3 id="config-example">example /config.mjs</h3><div class="Pre lines"><div class="menu"><button>copy</button></div><pre><code class="line"><span class="keyword">export</span> <span class="keyword">default</span> {</code><code class="line"> <span class="colon">ROOT</span>: <span class="string">&#39;example&#39;</span>,</code><code class="line"> <span class="colon">THEME</span>: <span class="string">&#39;blue&#39;</span>,</code><code class="line"> <span class="colon">WEB_ROOT</span>: <span class="string">&#39;/core/&#39;</span>,</code><code class="line"></code><code class="line"><span class="comment"> // <span class="keyword">this</span> option adds the</span></code><code class="line"><span class="comment"> // <span class="string">&#39;X-Clacks-Overhead&#39;</span>, <span class="string">&#39;GNU Terry Pratchet&#39;</span></span></code><code class="line"><span class="comment"> // http header</span></code><code class="line"><span class="comment"> // see http://www.gnuterrypratchett.com/</span></code><code class="line"> <span class="colon">FOR_DEATH_CAN_NOT_HAVE_HIM</span>: <span class="boolean">true</span>,</code><code class="line"></code><code class="line"><span class="comment"> // <span class="keyword">default</span> CLIENT_LIB_NAME, overwrite to change names of transpiled css and js files</span></code><code class="line"> <span class="colon">CLIENT_LIB_NAME</span>: <span class="string">&#39;magic&#39;</span>,</code><code class="line">}</code></pre></div><a href="https://github.com/magic/core/blob/master/src/modules/Menu.mjs" target="_blank" rel="noopener">Menu.mjs on github</a></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="/core/magic.js?2Xn8S9cURI" integrity="sha384-2Xn8S9cURInobIW9YTRATwcQAhpUqrAR39fH2cBm9Aml4zQ794snEdOQ0o/GoOgA" crossorigin="anonymous"></script></body></html>
2 changes: 1 addition & 1 deletion docs/index.html
View file
Expand Up @@ -16,4 +16,4 @@
serverless lambdas, derived from the
<a href="https://github.com/magic-modules/" target="_blank" rel="noopener">@magic-modules</a>
you use in your pages.</p><p>this makes visitor statistics, user authentication and authorization,
chat, and all other server side services possible.</p></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="/core/magic.js?aWIROZ5161" integrity="sha384-aWIROZ5161nRWBO7FGm5kenNt8/yAW0dvC/FQzKipxTvofcxvgA5c+g91xoMN1AP" crossorigin="anonymous"></script></body></html>
chat, and all other server side services possible.</p></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="/core/magic.js?2Xn8S9cURI" integrity="sha384-2Xn8S9cURInobIW9YTRATwcQAhpUqrAR39fH2cBm9Aml4zQ794snEdOQ0o/GoOgA" crossorigin="anonymous"></script></body></html>

0 comments on commit 9f4aa9c

Please sign in to comment.