Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@StoneCypher
StoneCypher committed Jun 17, 2022
1 parent 3e9590c commit 56ff662
Show file tree
Hide file tree
Showing 19 changed files with 235 additions and 118 deletions.
7 changes: 7 additions & 0 deletions docs/docs/assets/custom.css
View file
Expand Up @@ -60,3 +60,10 @@ pre { border-radius: 0.3em; }
.rot_th_tab th+th+th,
.rot_th_tab td+td+td { padding: 6px 4px; min-width: 1.3em; }
.rot { transform-origin: 0 0; transform: rotate(-90deg); display: inline-block; position: absolute; left: 0.25em; bottom: -0.75em; font-weight: 400; }

html li.pages-entry-depth-0 { padding-left: 15px; }
html li.pages-entry-depth-1 { padding-left: 30px; }
html li.pages-entry-depth-2 { padding-left: 45px; }
html li.pages-entry-depth-3 { padding-left: 60px; }
html li.pages-entry-depth-4 { padding-left: 75px; }
html li.pages-entry-depth-5 { padding-left: 90px; }
2 changes: 1 addition & 1 deletion docs/docs/assets/search.js
View file

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions docs/docs/classes/Machine.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/docs/index.html
View file
Expand Up @@ -115,4 +115,4 @@ <h2>High speed</h2>
<p>Correct. Easy. Brief. Powerful. Fast.</p>
<p>Meet your new state machine.</p>
<p><code>Next</code>: <a href="pages/GettingStarted.html">Let&#39;s get started</a>.</p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-0"><a>Tutorials</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/WhatAreStateMachines.html">What are state machines?</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/GettingStarted.html">☕ <wbr/>Quick <wbr/>Start</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/LanguageReference.html">Language reference</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/todo.html">API reference</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/ExampleMachines.html">Example machines</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-1"><a>Howtos and <wbr/>Recipes</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-2"><a>Frameworks</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">React</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Vue</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Angular</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Node</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-2"><a>Environments</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Node</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Typescript</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">The browser</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Deno</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">AWS <wbr/>Lambda</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">SQL</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-2"><a>Bundling</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Rollup</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Webpack</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">CDN</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Local files</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/todo.html">Publishing</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/Styling.html">Theme, style, color</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-1"><a>Comparisons</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/FeatureComparison.html">Feature comparison</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/Shootout.html">LOC <wbr/>Shootout</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-0"><a>Tools</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/live_editor.html">Live <wbr/>Editor</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/todo.html">Github <wbr/>Action</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-0"><a href="pages/community.html">Community</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-0"><a href="pages/CHANGELOG.long.html">Changelog</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Machine.html" class="tsd-kind-icon">Machine</a></li><li class="tsd-kind-variable"><a href="modules.html#gviz_shapes" class="tsd-kind-icon">gviz_<wbr/>shapes</a></li><li class="tsd-kind-variable"><a href="modules.html#histograph" class="tsd-kind-icon">histograph</a></li><li class="tsd-kind-variable"><a href="modules.html#named_colors" class="tsd-kind-icon">named_<wbr/>colors</a></li><li class="tsd-kind-variable"><a href="modules.html#shapes" class="tsd-kind-icon">shapes</a></li><li class="tsd-kind-variable"><a href="modules.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-variable"><a href="modules.html#weighted_histo_key" class="tsd-kind-icon">weighted_<wbr/>histo_<wbr/>key</a></li><li class="tsd-kind-variable"><a href="modules.html#weighted_rand_select" class="tsd-kind-icon">weighted_<wbr/>rand_<wbr/>select</a></li><li class="tsd-kind-variable"><a href="modules.html#weighted_sample_select" class="tsd-kind-icon">weighted_<wbr/>sample_<wbr/>select</a></li><li class="tsd-kind-function"><a href="modules.html#arrow_direction" class="tsd-kind-icon">arrow_<wbr/>direction</a></li><li class="tsd-kind-function"><a href="modules.html#arrow_left_kind" class="tsd-kind-icon">arrow_<wbr/>left_<wbr/>kind</a></li><li class="tsd-kind-function"><a href="modules.html#arrow_right_kind" class="tsd-kind-icon">arrow_<wbr/>right_<wbr/>kind</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#compile" class="tsd-kind-icon">compile</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#from" class="tsd-kind-icon">from</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#make" class="tsd-kind-icon">make</a></li><li class="tsd-kind-function"><a href="modules.html#parse" class="tsd-kind-icon">parse</a></li><li class="tsd-kind-function"><a href="modules.html#seq" class="tsd-kind-icon">seq</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#sm" class="tsd-kind-icon">sm</a></li><li class="tsd-kind-function"><a href="modules.html#transfer_state_properties" class="tsd-kind-icon">transfer_<wbr/>state_<wbr/>properties</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-0"><a>Tutorials</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/WhatAreStateMachines.html">What are state machines?</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/GettingStarted.html">☕ <wbr/>Quick <wbr/>Start</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/LanguageReference.html">Language reference</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/todo.html">API reference</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/ExampleMachines.html">Example machines</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-1"><a>Howtos and <wbr/>Recipes</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-2"><a>Frameworks</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">React</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Vue</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Angular</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Node</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">CLI</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-2"><a>Environments</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Node</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Typescript</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">The browser</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Deno</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">AWS <wbr/>Lambda</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">SQL</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-2"><a>Bundling</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Rollup</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Webpack</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">CDN</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-3"><a href="pages/todo.html">Local files</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/todo.html">Let&#39;s make a large machine</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/todo.html">Publishing</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/Styling.html">Theme, style, color</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-1"><a>Comparisons</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/FeatureComparison.html">Feature comparison</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-2"><a href="pages/Shootout.html">LOC <wbr/>Shootout</a></li><li class=" pages-entry pages-entry-menu pages-entry-depth-0"><a>Tools</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/live_editor.html">Live <wbr/>Editor</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-1"><a href="pages/todo.html">Github <wbr/>Action</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-0"><a href="pages/community.html">Community</a></li><li class=" pages-entry pages-entry-page pages-entry-depth-0"><a href="pages/CHANGELOG.long.html">Changelog</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/Machine.html" class="tsd-kind-icon">Machine</a></li><li class="tsd-kind-variable"><a href="modules.html#gviz_shapes" class="tsd-kind-icon">gviz_<wbr/>shapes</a></li><li class="tsd-kind-variable"><a href="modules.html#histograph" class="tsd-kind-icon">histograph</a></li><li class="tsd-kind-variable"><a href="modules.html#named_colors" class="tsd-kind-icon">named_<wbr/>colors</a></li><li class="tsd-kind-variable"><a href="modules.html#shapes" class="tsd-kind-icon">shapes</a></li><li class="tsd-kind-variable"><a href="modules.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-variable"><a href="modules.html#weighted_histo_key" class="tsd-kind-icon">weighted_<wbr/>histo_<wbr/>key</a></li><li class="tsd-kind-variable"><a href="modules.html#weighted_rand_select" class="tsd-kind-icon">weighted_<wbr/>rand_<wbr/>select</a></li><li class="tsd-kind-variable"><a href="modules.html#weighted_sample_select" class="tsd-kind-icon">weighted_<wbr/>sample_<wbr/>select</a></li><li class="tsd-kind-function"><a href="modules.html#arrow_direction" class="tsd-kind-icon">arrow_<wbr/>direction</a></li><li class="tsd-kind-function"><a href="modules.html#arrow_left_kind" class="tsd-kind-icon">arrow_<wbr/>left_<wbr/>kind</a></li><li class="tsd-kind-function"><a href="modules.html#arrow_right_kind" class="tsd-kind-icon">arrow_<wbr/>right_<wbr/>kind</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#compile" class="tsd-kind-icon">compile</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#from" class="tsd-kind-icon">from</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#make" class="tsd-kind-icon">make</a></li><li class="tsd-kind-function"><a href="modules.html#parse" class="tsd-kind-icon">parse</a></li><li class="tsd-kind-function"><a href="modules.html#seq" class="tsd-kind-icon">seq</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#sm" class="tsd-kind-icon">sm</a></li><li class="tsd-kind-function"><a href="modules.html#transfer_state_properties" class="tsd-kind-icon">transfer_<wbr/>state_<wbr/>properties</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>

0 comments on commit 56ff662

Please sign in to comment.