-
Notifications
You must be signed in to change notification settings - Fork 6
/
index.html
206 lines (206 loc) · 7.84 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>p5.teach.js</title>
<meta name="description" content="Documentation for p5.teach.js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">p5.teach.js</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>p5.teach.js</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#p5teachjs" id="p5teachjs" style="color: inherit; text-decoration: none;">
<h1>p5.teach.js</h1>
</a>
<img src="assets/p5-astrik-teach.png" alt="astrik-logo" />
<blockquote>
<p>A beginner friendly math animation library for p5.js</p>
</blockquote>
<p>p5.teach.js provides tools for teaching through p5.js, such as functions to animate text, TeX, and shapes.</p>
<a href="#get-started" id="get-started" style="color: inherit; text-decoration: none;">
<h2>Get Started</h2>
</a>
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
<h2>Documentation</h2>
</a>
<ul>
<li><a href="https://two-ticks.github.io/p5.teach.js/docs/index.html">TypeDoc Documentation</a></li>
<li><a href="https://two-ticks.github.io/p5.teach.js/api_reference.md">API Reference</a></li>
<li><a href="https://editor.p5js.org/radium.scientist/collections/-xxYz8cof">Example Sketches</a></li>
</ul>
<a href="#setting-up-the-development-environment" id="setting-up-the-development-environment" style="color: inherit; text-decoration: none;">
<h2>Setting up the development environment</h2>
</a>
<ol>
<li>Yarn should be preinstalled</li>
<li>Run <code>yarn install</code> for installing the dependencies</li>
<li>Run <code>yarn dev</code> for running the dev environment</li>
<li>As the code is updated, the final js file is updated in <code>dist/p5.teach.js</code> dynamically</li>
<li>The sketch in the <code>index.html</code> file is reflected with the changes</li>
</ol>
<a href="#generating-documentation" id="generating-documentation" style="color: inherit; text-decoration: none;">
<h2>Generating documentation</h2>
</a>
<ol>
<li>We use <code>TypeDoc</code> </li>
<li>Run <code>yarn typedoc src</code> for generating docs</li>
</ol>
<a href="#tests" id="tests" style="color: inherit; text-decoration: none;">
<h2>Tests</h2>
</a>
<ol>
<li>We use <code>jest</code> for testing</li>
<li>Run <code>yarn test</code> for running tests</li>
<li>Tests are in <code>src/test</code></li>
</ol>
<a href="#formatting-the-code" id="formatting-the-code" style="color: inherit; text-decoration: none;">
<h2>Formatting the code</h2>
</a>
<ol>
<li>Before submitting PR, run <code>yarn prettier</code> to format the code</li>
</ol>
<a href="#build" id="build" style="color: inherit; text-decoration: none;">
<h2>Build</h2>
</a>
<ol>
<li>Run <code>yarn build</code> to export the final js file</li>
<li>Final js file is exported as <code>dist/p5.teach.js</code></li>
</ol>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Geometry_GObject.html">lib/<wbr>Geometry/GObject</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Geometry_Shape.html">lib/<wbr>Geometry/<wbr>Shape</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Geometry_arrow.html">lib/<wbr>Geometry/arrow</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Geometry_graph.html">lib/<wbr>Geometry/graph</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Geometry_parametric.html">lib/<wbr>Geometry/parametric</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Geometry_polar.html">lib/<wbr>Geometry/polar</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_MObject_MObject.html">lib/MObject/MObject</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_MObject_TeX.html">lib/MObject/<wbr>TeX</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_MObject_Text.html">lib/MObject/<wbr>Text</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Scene_add.html">lib/<wbr>Scene/add</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Scene_controls.html">lib/<wbr>Scene/controls</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Scene_group.html">lib/<wbr>Scene/group</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Scene_play.html">lib/<wbr>Scene/play</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Scene_scene.html">lib/<wbr>Scene/scene</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_Scene_transform.html">lib/<wbr>Scene/transform</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/lib_interfaces.html">lib/interfaces</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</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-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</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/js/main.js"></script>
</body>
</html>