Merge pull request #75 from crucialfelix/feature/render-docs

Feature: render docs
crucialfelix · Jan 9, 2020 · dd59539 · dd59539
2 parents 79f759e + c298c74
commit dd59539
Show file tree

Hide file tree

Showing 289 changed files with 3,994 additions and 65,243 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
-*.sh
 lib
 coverage
 .node-version

diff --git a/README.md b/README.md
@@ -242,7 +242,7 @@ sc.lang.boot().then(async function(lang) {
 Documentation
 -------------
 
-[TypeDocs](https://crucialfelix.github.io/supercolliderjs/packages/supercolliderjs/docs/index.html)
+[Documentation](https://crucialfelix.github.io/supercolliderjs/#/packages/supercolliderjs/api)
 
 Compatibility
 -------------

diff --git a/docs/README.md b/docs/README.md
@@ -242,7 +242,7 @@ sc.lang.boot().then(async function(lang) {
 Documentation
 -------------
 
-[TypeDocs](https://crucialfelix.github.io/supercolliderjs/packages/supercolliderjs/docs/index.html)
+[Documentation](https://crucialfelix.github.io/supercolliderjs/#/packages/supercolliderjs/api)
 
 Compatibility
 -------------

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,12 +1,79 @@
 - [Getting started](README.md)
 - npm packages
   - [supercolliderjs](packages/supercolliderjs/README.md)
+    - [API](packages/supercolliderjs/api.md)
+      - [server](packages/supercolliderjs/server.md)
+      - [dryads](packages/supercolliderjs/dryads.md)
+      - [lang](packages/supercolliderjs/lang.md)
+      - [map](packages/supercolliderjs/map.md)
+      - [msg](packages/supercolliderjs/msg.md)
+      - [SCLangError](packages/supercolliderjs/SCLangError.md)
+      - [resolveOptions](packages/supercolliderjs/resolveOptions.md)
   - [@supercollider/server](packages/server/README.md)
+    - [API](packages/server/api.md)
+      - [Server](packages/server/Server.md)
+      - [boot](packages/server/boot.md)
+      - [resolveOptions](packages/server/resolveOptions.md)
+      - [msg](packages/server/msg.md)
+      - [mapping](packages/server/mapping.md)
+      - [ServerState](packages/server/ServerState.md)
+      - [watchNodeNotifications](packages/server/watchNodeNotifications.md)
+      - [onNodeGo](packages/server/onNodeGo.md)
+      - [whenNodeGo](packages/server/whenNodeGo.md)
+      - [onNodeEnd](packages/server/onNodeEnd.md)
+      - [whenNodeEnd](packages/server/whenNodeEnd.md)
+      - [updateNodeState](packages/server/updateNodeState.md)
+      - [deltaTimeTag](packages/server/deltaTimeTag.md)
   - [@supercollider/server-plus](packages/server-plus/README.md)
+    - [API](packages/server-plus/api.md)
+      - [Group](packages/server-plus/Group.md)
+      - [Synth](packages/server-plus/Synth.md)
+      - [AudioBus](packages/server-plus/AudioBus.md)
+      - [ControlBus](packages/server-plus/ControlBus.md)
+      - [Buffer](packages/server-plus/Buffer.md)
+      - [SynthDef](packages/server-plus/SynthDef.md)
+      - [ServerPlus](packages/server-plus/ServerPlus.md)
+      - [boot](packages/server-plus/boot.md)
   - [@supercollider/lang](packages/lang/README.md)
+    - [API](packages/lang/api.md)
+      - [SCLang](packages/lang/SCLang.md)
+      - [boot](packages/lang/boot.md)
+      - [resolveOptions](packages/lang/resolveOptions.md)
+      - [SynthDefCompiler](packages/lang/SynthDefCompiler.md)
+      - [SCLangError](packages/lang/SCLangError.md)
   - [@supercollider/dryads](packages/dryads/README.md)
+    - [API](packages/dryads/api.md)
+      - [SCServer](packages/dryads/SCServer.md)
+      - [SCLang](packages/dryads/SCLang.md)
+      - [Group](packages/dryads/Group.md)
+      - [Synth](packages/dryads/Synth.md)
+      - [AudioBus](packages/dryads/AudioBus.md)
+      - [SCSynthDef](packages/dryads/SCSynthDef.md)
+      - [SynthControl](packages/dryads/SynthControl.md)
+      - [SynthStream](packages/dryads/SynthStream.md)
+      - [SynthEventList](packages/dryads/SynthEventList.md)
+      - [layer](packages/dryads/layer.md)
+      - [dryadic](packages/dryads/dryadic.md)
+      - [play](packages/dryads/play.md)
+      - [h](packages/dryads/h.md)
   - [@supercollider/osc](packages/osc/README.md)
+    - [API](packages/osc/api.md)
+      - [packMessage](packages/osc/packMessage.md)
+      - [packBundle](packages/osc/packBundle.md)
+      - [unpack](packages/osc/unpack.md)
+      - [unpackMessage](packages/osc/unpackMessage.md)
+      - [unpackBundle](packages/osc/unpackBundle.md)
+      - [pack](packages/osc/pack.md)
+      - [dateToTimetag](packages/osc/dateToTimetag.md)
+      - [timetagToDate](packages/osc/timetagToDate.md)
+      - [deltaTimeTag](packages/osc/deltaTimeTag.md)
+      - [asNTPTimeTag](packages/osc/asNTPTimeTag.md)
+  - [@supercollider/logger](packages/logger/README.md)
+    - [API](packages/logger/api.md)
+      - [Logger](packages/logger/Logger.md)
   - [@supercollider/scapi](packages/scapi/README.md)
+    - [API](packages/scapi/api.md)
+      - [SCAPI](packages/scapi/SCAPI.md)
 - Guide
   - [Guide](https://crucialfelix.gitbooks.io/supercollider-js-guide/content/)
-  - [Examples](https://github.com/crucialfelix/supercolliderjs-examples)
+  - [Examples](https://github.com/crucialfelix/supercolliderjs-examples)
diff --git a/docs/index.html b/docs/index.html
@@ -14,18 +14,19 @@
 	<!-- <link rel="stylesheet" href="https://unpkg.com/docsify-themeable/dist/css/theme-defaults.css"> -->
 
 	<!-- 2. PrismJS Themes -->
-	<!-- <link rel="stylesheet"  href="https://unpkg.com/prism-github/prism-github.css"> -->
+	<link rel="stylesheet" href="https://unpkg.com/prism-github/prism-github.css">
 	<!-- <link rel="stylesheet" href="https://unpkg.com/prism-themes/themes/prism-synthwave84.css"> -->
-	<link rel="stylesheet" href="https://unpkg.com/prism-themes/themes/prism-atom-dark.css">
+	<!-- <link rel="stylesheet"  href="https://unpkg.com/prism-themes/themes/prism-atom-dark.css"> -->
 	<!-- <link rel="stylesheet" href="https://unpkg.com/prism-theme-one-dark/prism-onedark.css"> -->
 
   <style>
     @media (max-width: 768px) {
       .markdown-section {
         padding: 2rem 0.25rem 2rem 0.5rem;
       }
-      p {
+      p, .markdown-section p {
         line-height: 1.2;
+        margin: 0 0 1em 0;
       }
       li {
         font-size: 0.9rem;
@@ -42,6 +43,73 @@
       display: block;
       margin-top: -1rem;
     }
+    .pl2 {
+      padding-left: 1rem;
+    }
+    ul.no-dot {
+      list-style-type: none;
+      margin: 0;
+    }
+    ul.no-dot p {
+      margin: 0 0 6px 0;
+      line-height: 1.2;
+    }
+    div.module {
+      margin: 1rem 0;
+      padding: 1rem;
+      background: #e2e1e04d;
+      border-radius: 2px;
+      display: inline-block;
+      position: relative;
+    }
+    .module-child {
+      background: #fff;
+    }
+    .entity-box {
+      border-radius: 2px;
+      display: inline-block;
+      margin: 1rem;
+      padding: 1rem;
+      position: relative;
+      width: 95%;
+      max-width: 50rem;
+
+      box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24);
+      transition: all 0.3s cubic-bezier(.25,.8,.25,1);
+    }
+    p {
+      font-size: 0.9rem;
+      line-height: 1.2;
+    }
+    .short-text {
+      font-weight: 500;
+      max-width: 40em;
+      line-height: 1.2;
+    }
+    h4 + p.short-text {
+      margin-top: 4px;
+    }
+    .class-member {
+      margin: 1em .5em 2em;
+    }
+    .class-member h4 {
+      margin: 0;
+    }
+    .class-member > p, .class-member > div {
+      margin-left: .5em;
+    }
+    .section-heading {
+      font-variant-caps: small-caps;
+      font-size: .9em;
+      padding-top: 2em;
+      letter-spacing: 0.1em;
+    }
+    .type {
+      font-style: italic;
+    }
+    .nowrap {
+      white-space: nowrap;
+    }
   </style>
 </head>
 <body>

diff --git a/docs/packages/dryads/AudioBus.md b/docs/packages/dryads/AudioBus.md
@@ -0,0 +1,7 @@
+# AudioBus
+Package: <a href="#/packages/dryads/api">@supercollider/dryads</a>
+
+<div class="entity-box"><div class="Class"><h3 class="class-header" id="AudioBus"><span class="token keyword">class</span> <span class="class">AudioBus</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad&lt;<span class="type reference">Properties</span>&gt;</span><p class="short-text">Allocates an audio bus, making it available in the children's context as .out (integer)
+and .numChannels (integer)</p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">Properties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented
+(dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">Properties</span></h4></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="requireParent"><span class="token function">requireParent</span>(): <span class="type token entity">string</span></h4><p class="short-text">If there is no SCServer in the parent context,
+then this will wrap itself in an SCServer</p></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div>
diff --git a/docs/packages/dryads/Group.md b/docs/packages/dryads/Group.md
@@ -0,0 +1,7 @@
+# Group
+Package: <a href="#/packages/dryads/api">@supercollider/dryads</a>
+
+<div class="entity-box"><div class="Class"><h3 class="class-header" id="Group"><span class="token keyword">class</span> <span class="class">Group</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad</span><p class="short-text">Creates a group on the server; sets .group in context for its children,
+so any Synths or Groups will be spawned inside this group.</p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> P</h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented
+(dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"><h4 id="add"><span class="token function">add</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="requireParent"><span class="token function">requireParent</span>(): <span class="type token entity">string</span></h4><p class="short-text">If there is no SCServer in the parent context,
+then this will wrap itself in an SCServer</p></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div>
diff --git a/docs/packages/dryads/README.md b/docs/packages/dryads/README.md
@@ -82,7 +82,7 @@ play(out);
 Documentation
 -------------
 
-[TypeDocs](https://crucialfelix.github.io/supercolliderjs/packages/dryads/docs/index.html)
+[Documentation](https://crucialfelix.github.io/supercolliderjs/#/packages/dryads/api)
 
 Compatibility
 -------------

diff --git a/docs/packages/dryads/SCLang.md b/docs/packages/dryads/SCLang.md
@@ -0,0 +1,12 @@
+# SCLang
+Package: <a href="#/packages/dryads/api">@supercollider/dryads</a>
+
+<div class="entity-box"><div class="Class"><h3 class="class-header" id="SCLang"><span class="token keyword">class</span> <span class="class">SCLang</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad&lt;<span class="type reference">Properties</span>&gt;</span><p class="short-text">Boots a new SuperCollider language interpreter (sclang) making it available for all children as context.sclang</p><p class="">Always boots a new one, ignoring any possibly already existing one in the parent context.
+
+`options` are the command line options supplied to sclang (note: not all options are passed through yet)
+see {@link lang/SCLang}
+
+Not to be confused with the other class named SCLang which does all the hard work.
+This Dryad class is just a simple wrapper around that.
+</p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">Properties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented
+(dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">Properties</span></h4></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div>
diff --git a/docs/packages/dryads/SCServer.md b/docs/packages/dryads/SCServer.md
@@ -0,0 +1,9 @@
+# SCServer
+Package: <a href="#/packages/dryads/api">@supercollider/dryads</a>
+
+<div class="entity-box"><div class="Class"><h3 class="class-header" id="SCServer"><span class="token keyword">class</span> <span class="class">SCServer</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad&lt;<span class="type reference">ServerProperties</span>&gt;</span><p class="short-text">Boots a new SuperCollider server (scsynth) making it available for all children as `context.scserver`</p><p class="">Always boots a new one, ignoring any possibly already existing one in the parent context.
+
+`options` are the command line options supplied to scsynth (note: not all options are passed through yet)
+see {@link Server}
+</p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">ServerProperties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented
+(dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">ServerProperties</span></h4></div><div class="class-member"><h4 id="initialContext"><span class="token function">initialContext</span>(): <span class="type reference">Context</span></h4></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div>