Skip to content

Commit 310e90a

Browse files
jaehjaeh
committed
docs: update
1 parent cd848a6 commit 310e90a

File tree

19 files changed

+51
-51
lines changed

19 files changed

+51
-51
lines changed

‎docs/404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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="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?BnVIZARkUe" integrity="sha384-BnVIZARkUepuCe7lUhcDTsawIODTaXBIfw6mwgfxtO/WyMq3OWiOW72oJTjFamFf" 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?aSA1zeXIhc" integrity="sha384-aSA1zeXIhcXesx1cHXlzTfk17SzLe13f5hcfGDpE4F7vt6SIUQA9BSzJv5Y147Ue" crossorigin="anonymous"></script></body></html>
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="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?BnVIZARkUe" integrity="sha384-BnVIZARkUepuCe7lUhcDTsawIODTaXBIfw6mwgfxtO/WyMq3OWiOW72oJTjFamFf" 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?vXqF9dny1K" integrity="sha384-vXqF9dny1KkKKqix60V5QnTW6rjZ0eFK4/Odp5kbg7poHMFYNebc5MvVT2sEOD3h" crossorigin="anonymous"></script></body></html>

‎docs/concepts/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@
1111
you can define functions that get transpiled into serverside lambdas.
1212
server side lambdas will be available for GET and/or POST requests.</p><p>the server side function signature is (req, res) =&gt; {},
1313
as it is in most nodejs http servers,
14-
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?aSA1zeXIhc" integrity="sha384-aSA1zeXIhcXesx1cHXlzTfk17SzLe13f5hcfGDpE4F7vt6SIUQA9BSzJv5Y147Ue" crossorigin="anonymous"></script></body></html>
14+
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?vXqF9dny1K" integrity="sha384-vXqF9dny1KkKKqix60V5QnTW6rjZ0eFK4/Odp5kbg7poHMFYNebc5MvVT2sEOD3h" crossorigin="anonymous"></script></body></html>

‎docs/files/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
<a href="https://github.com/jaeh/node-zopfli-es" target="_blank" rel="noopener">node-zopfli-es</a>
66
(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
77
<a href="https://github.com/magic/css/" target="_blank" rel="noopener">@magic/css</a>
8-
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;overwritten.&#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>, &#39;GNU Terry Pratchet&#39; </span></code><code class="line"> <span class="comment">// http header </span></code><code class="line"> <span class="comment">// see <a href="http://www.gnuterrypratchett.com/" target="_blank" rel="noopener">http://www.gnuterrypratchett.com/</a></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><p><a href="https://github.com/magic/core/blob/master/src/modules/Menu.mjs" target="_blank" rel="noopener">Menu.mjs on github</a></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?aSA1zeXIhc" integrity="sha384-aSA1zeXIhcXesx1cHXlzTfk17SzLe13f5hcfGDpE4F7vt6SIUQA9BSzJv5Y147Ue" crossorigin="anonymous"></script></body></html>
8+
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;overwritten.&#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>, &#39;GNU Terry Pratchet&#39; </span></code><code class="line"> <span class="comment">// http header </span></code><code class="line"> <span class="comment">// see <a href="http://www.gnuterrypratchett.com/" target="_blank" rel="noopener">http://www.gnuterrypratchett.com/</a></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><p><a href="https://github.com/magic/core/blob/master/src/modules/Menu.mjs" target="_blank" rel="noopener">Menu.mjs on github</a></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?vXqF9dny1K" integrity="sha384-vXqF9dny1KkKKqix60V5QnTW6rjZ0eFK4/Odp5kbg7poHMFYNebc5MvVT2sEOD3h" crossorigin="anonymous"></script></body></html>

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
serverless lambdas, derived from the
1717
<a href="https://github.com/magic-modules/" target="_blank" rel="noopener">@magic-modules</a>
1818
you use in your pages.</p><p>this makes visitor statistics, user authentication and authorization,
19-
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?aSA1zeXIhc" integrity="sha384-aSA1zeXIhcXesx1cHXlzTfk17SzLe13f5hcfGDpE4F7vt6SIUQA9BSzJv5Y147Ue" crossorigin="anonymous"></script></body></html>
19+
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?vXqF9dny1K" integrity="sha384-vXqF9dny1KkKKqix60V5QnTW6rjZ0eFK4/Odp5kbg7poHMFYNebc5MvVT2sEOD3h" crossorigin="anonymous"></script></body></html>

0 commit comments

Comments
 (0)