Permalink
Browse files

added docco docs

  • Loading branch information...
1 parent 922e3ba commit 57d385e55da892fd16c3eea749dcae48280280ba @moul committed Dec 18, 2012
Showing with 677 additions and 0 deletions.
  1. +362 −0 docs/app.html
  2. +4 −0 docs/config.html
  3. +4 −0 docs/cron.html
  4. +72 −0 docs/defaultConfig.html
  5. +192 −0 docs/docco.css
  6. +19 −0 docs/index.html
  7. +4 −0 docs/stream.html
  8. +20 −0 docs/utils.html
View
Oops, something went wrong.
View
@@ -0,0 +1,4 @@
+<!DOCTYPE html> <html> <head> <title>config.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="app.html"> app.coffee </a> <a class="source" href="config.html"> config.coffee </a> <a class="source" href="cron.html"> cron.coffee </a> <a class="source" href="defaultConfig.html"> defaultConfig.coffee </a> <a class="source" href="index.html"> index.coffee </a> <a class="source" href="stream.html"> stream.coffee </a> <a class="source" href="utils.html"> utils.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> config.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">exports.cookie_secret = </span><span class="s">&quot;asdlgjsdklasdlgkjaslkdgjslkad&quot;</span>
+<span class="nv">exports.port = </span><span class="mi">8124</span>
+
+</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
View
@@ -0,0 +1,4 @@
+<!DOCTYPE html> <html> <head> <title>cron.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="app.html"> app.coffee </a> <a class="source" href="config.html"> config.coffee </a> <a class="source" href="cron.html"> cron.coffee </a> <a class="source" href="defaultConfig.html"> defaultConfig.coffee </a> <a class="source" href="index.html"> index.coffee </a> <a class="source" href="stream.html"> stream.coffee </a> <a class="source" href="utils.html"> utils.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> cron.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">module.exports = </span><span class="o">-&gt;</span>
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span> <span class="s">&quot;Running cron&quot;</span>
+
+</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
@@ -0,0 +1,72 @@
+<!DOCTYPE html> <html> <head> <title>defaultConfig.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To &hellip; <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="app.html"> app.coffee </a> <a class="source" href="config.html"> config.coffee </a> <a class="source" href="cron.html"> cron.coffee </a> <a class="source" href="defaultConfig.html"> defaultConfig.coffee </a> <a class="source" href="index.html"> index.coffee </a> <a class="source" href="stream.html"> stream.coffee </a> <a class="source" href="utils.html"> utils.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> defaultConfig.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">path = </span><span class="nx">require</span> <span class="s">&#39;path&#39;</span>
+
+<span class="nv">module.exports =</span>
+ <span class="nv">dirname: </span><span class="nx">process</span><span class="p">.</span><span class="nx">cwd</span><span class="p">()</span> <span class="o">||</span> <span class="nx">__dirname</span>
+ <span class="nv">dirs: </span><span class="p">[</span><span class="nx">process</span><span class="p">.</span><span class="nx">cwd</span><span class="p">(),</span> <span class="nx">__dirname</span><span class="p">,</span> <span class="nx">path</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="nx">__dirname</span><span class="p">,</span> <span class="s">&#39;..&#39;</span><span class="p">)]</span>
+ <span class="nv">port: </span><span class="mi">3000</span>
+ <span class="nv">debug: </span><span class="kc">false</span>
+ <span class="nv">cookie_secret: </span><span class="kc">null</span>
+ <span class="nv">session_secret: </span><span class="kc">null</span>
+ <span class="nv">session: </span><span class="kc">true</span>
+ <span class="nv">cookie: </span><span class="kc">true</span>
+ <span class="nv">stylus: </span><span class="kc">true</span>
+ <span class="nv">connect_assets: </span><span class="kc">true</span>
+ <span class="nv">hogan: </span><span class="kc">true</span>
+ <span class="nv">less: </span><span class="kc">false</span>
+ <span class="nv">compress: </span><span class="kc">true</span>
+ <span class="nv">cache: </span><span class="kc">true</span>
+ <span class="nv">viewEngine: </span><span class="s">&#39;jade&#39;</span> <span class="c1">#hjs</span>
+ <span class="nv">staticMaxAge: </span><span class="mi">86400</span>
+ <span class="nv">locals:</span>
+ <span class="nv">title: </span><span class="s">&#39;&#39;</span>
+ <span class="nv">site_name: </span><span class="s">&#39;Tapas&#39;</span>
+ <span class="nv">description: </span><span class="s">&quot;&quot;</span>
+ <span class="nv">css_libraries: </span><span class="p">[]</span>
+ <span class="nv">js_libraries: </span><span class="p">[]</span>
+ <span class="nv">use:</span>
+ <span class="nv">fontawesome: </span><span class="kc">true</span>
+ <span class="nv">bootstrap:</span>
+ <span class="nv">responsive: </span><span class="kc">false</span>
+ <span class="nv">navbar:</span>
+ <span class="nv">fixed: </span><span class="kc">false</span>
+ <span class="nv">fixedNavbar: </span><span class="kc">false</span>
+ <span class="nv">fluid: </span><span class="kc">false</span>
+ <span class="nv">collapsibleNavbar: </span><span class="kc">false</span>
+ <span class="nv">user:</span>
+ <span class="nv">navbar: </span><span class="kc">false</span>
+ <span class="nv">menus:</span>
+ <span class="nv">navbar:</span>
+ <span class="s">&#39;/&#39;</span><span class="o">:</span>
+ <span class="nv">title: </span><span class="s">&#39;Home&#39;</span>
+ <span class="nv">primary:</span>
+ <span class="s">&#39;/&#39;</span><span class="o">:</span>
+ <span class="nv">title: </span><span class="s">&#39;Home&#39;</span>
+ <span class="s">&#39;/login&#39;</span><span class="o">:</span>
+ <span class="nv">title: </span><span class="s">&#39;Login&#39;</span>
+ <span class="s">&#39;/register&#39;</span><span class="o">:</span>
+ <span class="nv">title: </span><span class="s">&#39;Register&#39;</span>
+ <span class="s">&#39;/logout&#39;</span><span class="o">:</span>
+ <span class="nv">title: </span><span class="s">&#39;Logout&#39;</span>
+ <span class="nv">regions:</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <p>left:
+navbar:
+content:
+left:
+right:</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">footer:</span>
+ <span class="s">&#39;copyright&#39;</span><span class="o">:</span> <span class="s">&#39;&lt;p&gt;Copyright 2012&lt;/p&gt;&#39;</span>
+ <span class="s">&#39;backToTop&#39;</span><span class="o">:</span> <span class="s">&#39;&lt;p class=&quot;pull-right&quot;&gt;&lt;a href=&quot;#&quot;&gt;Back to top&lt;/a&gt;&lt;/p&gt;&#39;</span>
+ <span class="nv">grid:</span>
+ <span class="nv">size: </span><span class="mi">12</span>
+ <span class="nv">content: </span><span class="mi">12</span>
+ <span class="nv">left: </span><span class="mi">3</span>
+ <span class="nv">right: </span><span class="mi">3</span>
+ <span class="nv">classes:</span>
+ <span class="nv">content: </span><span class="p">[]</span>
+ <span class="nv">left: </span><span class="p">[]</span>
+ <span class="nv">right: </span><span class="p">[]</span>
+ <span class="nv">viewOptions:</span>
+ <span class="nv">layout: </span><span class="kc">false</span>
+ <span class="nv">pretty: </span><span class="kc">false</span>
+ <span class="nv">complexNames: </span><span class="kc">true</span>
+ <span class="nv">ksAppConfigure: </span><span class="kc">true</span>
+
+</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>
View
@@ -0,0 +1,192 @@
+/*--------------------- Layout and Typography ----------------------------*/
+body {
+ font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
+ font-size: 15px;
+ line-height: 22px;
+ color: #252519;
+ margin: 0; padding: 0;
+}
+a {
+ color: #261a3b;
+}
+ a:visited {
+ color: #261a3b;
+ }
+p {
+ margin: 0 0 15px 0;
+}
+h1, h2, h3, h4, h5, h6 {
+ margin: 0px 0 15px 0;
+}
+ h1 {
+ margin-top: 40px;
+ }
+hr {
+ border: 0 none;
+ border-top: 1px solid #e5e5ee;
+ height: 1px;
+ margin: 20px 0;
+}
+#container {
+ position: relative;
+}
+#background {
+ position: fixed;
+ top: 0; left: 525px; right: 0; bottom: 0;
+ background: #f5f5ff;
+ border-left: 1px solid #e5e5ee;
+ z-index: -1;
+}
+#jump_to, #jump_page {
+ background: white;
+ -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
+ -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
+ font: 10px Arial;
+ text-transform: uppercase;
+ cursor: pointer;
+ text-align: right;
+}
+#jump_to, #jump_wrapper {
+ position: fixed;
+ right: 0; top: 0;
+ padding: 5px 10px;
+}
+ #jump_wrapper {
+ padding: 0;
+ display: none;
+ }
+ #jump_to:hover #jump_wrapper {
+ display: block;
+ }
+ #jump_page {
+ padding: 5px 0 3px;
+ margin: 0 0 25px 25px;
+ }
+ #jump_page .source {
+ display: block;
+ padding: 5px 10px;
+ text-decoration: none;
+ border-top: 1px solid #eee;
+ }
+ #jump_page .source:hover {
+ background: #f5f5ff;
+ }
+ #jump_page .source:first-child {
+ }
+table td {
+ border: 0;
+ outline: 0;
+}
+ td.docs, th.docs {
+ max-width: 450px;
+ min-width: 450px;
+ min-height: 5px;
+ padding: 10px 25px 1px 50px;
+ overflow-x: hidden;
+ vertical-align: top;
+ text-align: left;
+ }
+ .docs pre {
+ margin: 15px 0 15px;
+ padding-left: 15px;
+ }
+ .docs p tt, .docs p code {
+ background: #f8f8ff;
+ border: 1px solid #dedede;
+ font-size: 12px;
+ padding: 0 0.2em;
+ }
+ .pilwrap {
+ position: relative;
+ }
+ .pilcrow {
+ font: 12px Arial;
+ text-decoration: none;
+ color: #454545;
+ position: absolute;
+ top: 3px; left: -20px;
+ padding: 1px 2px;
+ opacity: 0;
+ -webkit-transition: opacity 0.2s linear;
+ }
+ td.docs:hover .pilcrow {
+ opacity: 1;
+ }
+ td.code, th.code {
+ padding: 14px 15px 16px 25px;
+ width: 100%;
+ vertical-align: top;
+ background: #f5f5ff;
+ border-left: 1px solid #e5e5ee;
+ }
+ pre, tt, code {
+ font-size: 12px; line-height: 18px;
+ font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace;
+ margin: 0; padding: 0;
+ }
+
+
+/*---------------------- Syntax Highlighting -----------------------------*/
+td.linenos { background-color: #f0f0f0; padding-right: 10px; }
+span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
+body .hll { background-color: #ffffcc }
+body .c { color: #408080; font-style: italic } /* Comment */
+body .err { border: 1px solid #FF0000 } /* Error */
+body .k { color: #954121 } /* Keyword */
+body .o { color: #666666 } /* Operator */
+body .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+body .cp { color: #BC7A00 } /* Comment.Preproc */
+body .c1 { color: #408080; font-style: italic } /* Comment.Single */
+body .cs { color: #408080; font-style: italic } /* Comment.Special */
+body .gd { color: #A00000 } /* Generic.Deleted */
+body .ge { font-style: italic } /* Generic.Emph */
+body .gr { color: #FF0000 } /* Generic.Error */
+body .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+body .gi { color: #00A000 } /* Generic.Inserted */
+body .go { color: #808080 } /* Generic.Output */
+body .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
+body .gs { font-weight: bold } /* Generic.Strong */
+body .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+body .gt { color: #0040D0 } /* Generic.Traceback */
+body .kc { color: #954121 } /* Keyword.Constant */
+body .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */
+body .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */
+body .kp { color: #954121 } /* Keyword.Pseudo */
+body .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */
+body .kt { color: #B00040 } /* Keyword.Type */
+body .m { color: #666666 } /* Literal.Number */
+body .s { color: #219161 } /* Literal.String */
+body .na { color: #7D9029 } /* Name.Attribute */
+body .nb { color: #954121 } /* Name.Builtin */
+body .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+body .no { color: #880000 } /* Name.Constant */
+body .nd { color: #AA22FF } /* Name.Decorator */
+body .ni { color: #999999; font-weight: bold } /* Name.Entity */
+body .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
+body .nf { color: #0000FF } /* Name.Function */
+body .nl { color: #A0A000 } /* Name.Label */
+body .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+body .nt { color: #954121; font-weight: bold } /* Name.Tag */
+body .nv { color: #19469D } /* Name.Variable */
+body .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+body .w { color: #bbbbbb } /* Text.Whitespace */
+body .mf { color: #666666 } /* Literal.Number.Float */
+body .mh { color: #666666 } /* Literal.Number.Hex */
+body .mi { color: #666666 } /* Literal.Number.Integer */
+body .mo { color: #666666 } /* Literal.Number.Oct */
+body .sb { color: #219161 } /* Literal.String.Backtick */
+body .sc { color: #219161 } /* Literal.String.Char */
+body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */
+body .s2 { color: #219161 } /* Literal.String.Double */
+body .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
+body .sh { color: #219161 } /* Literal.String.Heredoc */
+body .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
+body .sx { color: #954121 } /* Literal.String.Other */
+body .sr { color: #BB6688 } /* Literal.String.Regex */
+body .s1 { color: #219161 } /* Literal.String.Single */
+body .ss { color: #19469D } /* Literal.String.Symbol */
+body .bp { color: #954121 } /* Name.Builtin.Pseudo */
+body .vc { color: #19469D } /* Name.Variable.Class */
+body .vg { color: #19469D } /* Name.Variable.Global */
+body .vi { color: #19469D } /* Name.Variable.Instance */
+body .il { color: #666666 } /* Literal.Number.Integer.Long */
Oops, something went wrong.

0 comments on commit 57d385e

Please sign in to comment.