@teachinglab/omd 0.6.1 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +257 -251
- package/README.old.md +137 -137
- package/canvas/core/canvasConfig.js +202 -202
- package/canvas/drawing/segment.js +167 -167
- package/canvas/drawing/stroke.js +385 -385
- package/canvas/events/eventManager.js +444 -444
- package/canvas/events/pointerEventHandler.js +262 -262
- package/canvas/index.js +48 -48
- package/canvas/tools/PointerTool.js +71 -71
- package/canvas/tools/tool.js +222 -222
- package/canvas/utils/boundingBox.js +377 -377
- package/canvas/utils/mathUtils.js +258 -258
- package/docs/api/configuration-options.md +198 -198
- package/docs/api/eventManager.md +82 -82
- package/docs/api/focusFrameManager.md +144 -144
- package/docs/api/index.md +105 -105
- package/docs/api/main.md +62 -62
- package/docs/api/omdBinaryExpressionNode.md +86 -86
- package/docs/api/omdCanvas.md +83 -83
- package/docs/api/omdConfigManager.md +112 -112
- package/docs/api/omdConstantNode.md +52 -52
- package/docs/api/omdDisplay.md +87 -87
- package/docs/api/omdEquationNode.md +174 -174
- package/docs/api/omdEquationSequenceNode.md +258 -258
- package/docs/api/omdEquationStack.md +192 -192
- package/docs/api/omdFunctionNode.md +82 -82
- package/docs/api/omdGroupNode.md +78 -78
- package/docs/api/omdHelpers.md +87 -87
- package/docs/api/omdLeafNode.md +85 -85
- package/docs/api/omdNode.md +201 -201
- package/docs/api/omdOperationDisplayNode.md +117 -117
- package/docs/api/omdOperatorNode.md +91 -91
- package/docs/api/omdParenthesisNode.md +133 -133
- package/docs/api/omdPopup.md +191 -191
- package/docs/api/omdPowerNode.md +131 -131
- package/docs/api/omdRationalNode.md +144 -144
- package/docs/api/omdSequenceNode.md +128 -128
- package/docs/api/omdSimplification.md +78 -78
- package/docs/api/omdSqrtNode.md +144 -144
- package/docs/api/omdStepVisualizer.md +146 -146
- package/docs/api/omdStepVisualizerHighlighting.md +65 -65
- package/docs/api/omdStepVisualizerInteractiveSteps.md +108 -108
- package/docs/api/omdStepVisualizerLayout.md +70 -70
- package/docs/api/omdStepVisualizerNodeUtils.md +140 -140
- package/docs/api/omdStepVisualizerTextBoxes.md +76 -76
- package/docs/api/omdToolbar.md +130 -130
- package/docs/api/omdTranscriptionService.md +95 -95
- package/docs/api/omdTreeDiff.md +169 -169
- package/docs/api/omdUnaryExpressionNode.md +137 -137
- package/docs/api/omdUtilities.md +82 -82
- package/docs/api/omdVariableNode.md +123 -123
- package/docs/api/selectTool.md +74 -74
- package/docs/api/simplificationEngine.md +97 -97
- package/docs/api/simplificationRules.md +76 -76
- package/docs/api/simplificationUtils.md +64 -64
- package/docs/api/transcribe.md +43 -43
- package/docs/api-reference.md +85 -85
- package/docs/index.html +453 -453
- package/docs/index.md +38 -38
- package/docs/omd-objects.md +258 -258
- package/index.js +79 -79
- package/jsvg/index.js +3 -0
- package/jsvg/jsvg.js +898 -898
- package/jsvg/jsvgComponents.js +357 -358
- package/npm-docs/DOCUMENTATION_SUMMARY.md +220 -220
- package/npm-docs/README.md +251 -251
- package/npm-docs/api/api-reference.md +85 -85
- package/npm-docs/api/configuration-options.md +198 -198
- package/npm-docs/api/eventManager.md +82 -82
- package/npm-docs/api/expression-nodes.md +561 -561
- package/npm-docs/api/focusFrameManager.md +144 -144
- package/npm-docs/api/index.md +105 -105
- package/npm-docs/api/main.md +62 -62
- package/npm-docs/api/omdBinaryExpressionNode.md +86 -86
- package/npm-docs/api/omdCanvas.md +83 -83
- package/npm-docs/api/omdConfigManager.md +112 -112
- package/npm-docs/api/omdConstantNode.md +52 -52
- package/npm-docs/api/omdDisplay.md +87 -87
- package/npm-docs/api/omdEquationNode.md +174 -174
- package/npm-docs/api/omdEquationSequenceNode.md +258 -258
- package/npm-docs/api/omdEquationStack.md +192 -192
- package/npm-docs/api/omdFunctionNode.md +82 -82
- package/npm-docs/api/omdGroupNode.md +78 -78
- package/npm-docs/api/omdHelpers.md +87 -87
- package/npm-docs/api/omdLeafNode.md +85 -85
- package/npm-docs/api/omdNode.md +201 -201
- package/npm-docs/api/omdOperationDisplayNode.md +117 -117
- package/npm-docs/api/omdOperatorNode.md +91 -91
- package/npm-docs/api/omdParenthesisNode.md +133 -133
- package/npm-docs/api/omdPopup.md +191 -191
- package/npm-docs/api/omdPowerNode.md +131 -131
- package/npm-docs/api/omdRationalNode.md +144 -144
- package/npm-docs/api/omdSequenceNode.md +128 -128
- package/npm-docs/api/omdSimplification.md +78 -78
- package/npm-docs/api/omdSqrtNode.md +144 -144
- package/npm-docs/api/omdStepVisualizer.md +146 -146
- package/npm-docs/api/omdStepVisualizerHighlighting.md +65 -65
- package/npm-docs/api/omdStepVisualizerInteractiveSteps.md +108 -108
- package/npm-docs/api/omdStepVisualizerLayout.md +70 -70
- package/npm-docs/api/omdStepVisualizerNodeUtils.md +140 -140
- package/npm-docs/api/omdStepVisualizerTextBoxes.md +76 -76
- package/npm-docs/api/omdToolbar.md +130 -130
- package/npm-docs/api/omdTranscriptionService.md +95 -95
- package/npm-docs/api/omdTreeDiff.md +169 -169
- package/npm-docs/api/omdUnaryExpressionNode.md +137 -137
- package/npm-docs/api/omdUtilities.md +82 -82
- package/npm-docs/api/omdVariableNode.md +123 -123
- package/npm-docs/api/selectTool.md +74 -74
- package/npm-docs/api/simplificationEngine.md +97 -97
- package/npm-docs/api/simplificationRules.md +76 -76
- package/npm-docs/api/simplificationUtils.md +64 -64
- package/npm-docs/api/transcribe.md +43 -43
- package/npm-docs/guides/equations.md +854 -854
- package/npm-docs/guides/factory-functions.md +354 -354
- package/npm-docs/guides/getting-started.md +318 -318
- package/npm-docs/guides/quick-examples.md +525 -525
- package/npm-docs/guides/visualizations.md +682 -682
- package/npm-docs/index.html +12 -0
- package/npm-docs/json-schemas.md +826 -826
- package/omd/config/omdConfigManager.js +279 -267
- package/omd/core/index.js +158 -158
- package/omd/core/omdEquationStack.js +606 -547
- package/omd/core/omdUtilities.js +113 -113
- package/omd/display/omdDisplay.js +1045 -963
- package/omd/display/omdToolbar.js +501 -501
- package/omd/nodes/omdBinaryExpressionNode.js +459 -459
- package/omd/nodes/omdConstantNode.js +141 -141
- package/omd/nodes/omdEquationNode.js +1327 -1327
- package/omd/nodes/omdFunctionNode.js +351 -351
- package/omd/nodes/omdGroupNode.js +67 -67
- package/omd/nodes/omdLeafNode.js +76 -76
- package/omd/nodes/omdNode.js +556 -556
- package/omd/nodes/omdOperationDisplayNode.js +321 -321
- package/omd/nodes/omdOperatorNode.js +108 -108
- package/omd/nodes/omdParenthesisNode.js +292 -292
- package/omd/nodes/omdPowerNode.js +235 -235
- package/omd/nodes/omdRationalNode.js +295 -295
- package/omd/nodes/omdSqrtNode.js +307 -307
- package/omd/nodes/omdUnaryExpressionNode.js +227 -227
- package/omd/nodes/omdVariableNode.js +122 -122
- package/omd/simplification/omdSimplification.js +140 -140
- package/omd/simplification/omdSimplificationEngine.js +887 -887
- package/omd/simplification/package.json +5 -5
- package/omd/simplification/rules/binaryRules.js +1037 -1037
- package/omd/simplification/rules/functionRules.js +111 -111
- package/omd/simplification/rules/index.js +48 -48
- package/omd/simplification/rules/parenthesisRules.js +19 -19
- package/omd/simplification/rules/powerRules.js +143 -143
- package/omd/simplification/rules/rationalRules.js +725 -725
- package/omd/simplification/rules/sqrtRules.js +48 -48
- package/omd/simplification/rules/unaryRules.js +37 -37
- package/omd/simplification/simplificationRules.js +31 -31
- package/omd/simplification/simplificationUtils.js +1055 -1055
- package/omd/step-visualizer/omdStepVisualizer.js +947 -947
- package/omd/step-visualizer/omdStepVisualizerHighlighting.js +246 -246
- package/omd/step-visualizer/omdStepVisualizerLayout.js +892 -892
- package/omd/step-visualizer/omdStepVisualizerTextBoxes.js +200 -200
- package/omd/utils/aiNextEquationStep.js +106 -106
- package/omd/utils/omdNodeOverlay.js +638 -638
- package/omd/utils/omdPopup.js +1203 -1203
- package/omd/utils/omdStepVisualizerInteractiveSteps.js +684 -684
- package/omd/utils/omdStepVisualizerNodeUtils.js +267 -267
- package/omd/utils/omdTranscriptionService.js +123 -123
- package/omd/utils/omdTreeDiff.js +733 -733
- package/package.json +59 -57
- package/readme.html +184 -120
- package/src/index.js +74 -74
- package/src/json-schemas.md +576 -576
- package/src/omd-json-samples.js +147 -147
- package/src/omdApp.js +391 -391
- package/src/omdAppCanvas.js +335 -335
- package/src/omdBalanceHanger.js +199 -199
- package/src/omdColor.js +13 -13
- package/src/omdCoordinatePlane.js +541 -541
- package/src/omdExpression.js +115 -115
- package/src/omdFactory.js +150 -150
- package/src/omdFunction.js +114 -114
- package/src/omdMetaExpression.js +290 -290
- package/src/omdNaturalExpression.js +563 -563
- package/src/omdNode.js +383 -383
- package/src/omdNumber.js +52 -52
- package/src/omdNumberLine.js +114 -112
- package/src/omdNumberTile.js +118 -118
- package/src/omdOperator.js +72 -72
- package/src/omdPowerExpression.js +91 -91
- package/src/omdProblem.js +259 -259
- package/src/omdRatioChart.js +251 -251
- package/src/omdRationalExpression.js +114 -114
- package/src/omdSampleData.js +215 -215
- package/src/omdShapes.js +512 -512
- package/src/omdSpinner.js +151 -151
- package/src/omdString.js +49 -49
- package/src/omdTable.js +498 -498
- package/src/omdTapeDiagram.js +244 -244
- package/src/omdTerm.js +91 -91
- package/src/omdTileEquation.js +349 -349
- package/src/omdUtils.js +84 -84
- package/src/omdVariable.js +51 -51
package/docs/index.html
CHANGED
|
@@ -1,454 +1,454 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>OMD Library Documentation</title>
|
|
7
|
-
<style>
|
|
8
|
-
:root {
|
|
9
|
-
--primary: #3498db;
|
|
10
|
-
--primary-dark: #2980b9;
|
|
11
|
-
--text: #2c3e50;
|
|
12
|
-
--text-light: #666;
|
|
13
|
-
--bg: #f5f5f5;
|
|
14
|
-
--bg-card: #ffffff;
|
|
15
|
-
--border: #e9ecef;
|
|
16
|
-
--shadow: 0 2px 4px rgba(0,0,0,0.1);
|
|
17
|
-
--radius: 8px;
|
|
18
|
-
--transition: all 0.2s ease;
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
body {
|
|
22
|
-
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
|
23
|
-
line-height: 1.6;
|
|
24
|
-
color: var(--text);
|
|
25
|
-
margin: 0;
|
|
26
|
-
padding: 0;
|
|
27
|
-
background-color: var(--bg);
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
.header {
|
|
31
|
-
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
|
32
|
-
color: white;
|
|
33
|
-
padding: 40px 20px;
|
|
34
|
-
text-align: center;
|
|
35
|
-
margin-bottom: 40px;
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
.header h1 {
|
|
39
|
-
margin: 0;
|
|
40
|
-
font-size: 2.5em;
|
|
41
|
-
font-weight: 700;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
.header p {
|
|
45
|
-
margin: 10px 0 0;
|
|
46
|
-
opacity: 0.9;
|
|
47
|
-
font-size: 1.2em;
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
.container {
|
|
51
|
-
max-width: 1400px;
|
|
52
|
-
margin: 0 auto;
|
|
53
|
-
padding: 0 20px;
|
|
54
|
-
display: flex;
|
|
55
|
-
gap: 30px;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
.sidebar {
|
|
59
|
-
flex: 0 0 300px;
|
|
60
|
-
background: var(--bg-card);
|
|
61
|
-
padding: 25px;
|
|
62
|
-
border-radius: var(--radius);
|
|
63
|
-
box-shadow: var(--shadow);
|
|
64
|
-
height: fit-content;
|
|
65
|
-
position: sticky;
|
|
66
|
-
top: 20px;
|
|
67
|
-
max-height: calc(100vh - 40px);
|
|
68
|
-
overflow-y: auto;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
.content {
|
|
72
|
-
flex: 1;
|
|
73
|
-
background: var(--bg-card);
|
|
74
|
-
padding: 30px;
|
|
75
|
-
border-radius: var(--radius);
|
|
76
|
-
box-shadow: var(--shadow);
|
|
77
|
-
min-height: 800px;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
.nav-section {
|
|
81
|
-
margin-bottom: 25px;
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
.nav-section h3 {
|
|
85
|
-
color: var(--text);
|
|
86
|
-
font-size: 14px;
|
|
87
|
-
text-transform: uppercase;
|
|
88
|
-
margin: 0 0 15px;
|
|
89
|
-
padding-bottom: 8px;
|
|
90
|
-
border-bottom: 2px solid var(--border);
|
|
91
|
-
font-weight: 600;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
.nav-links {
|
|
95
|
-
list-style: none;
|
|
96
|
-
padding: 0;
|
|
97
|
-
margin: 0;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
.nav-links li {
|
|
101
|
-
margin-bottom: 5px;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
.nav-links a {
|
|
105
|
-
color: var(--text);
|
|
106
|
-
text-decoration: none;
|
|
107
|
-
display: block;
|
|
108
|
-
padding: 8px 12px;
|
|
109
|
-
border-radius: var(--radius);
|
|
110
|
-
transition: var(--transition);
|
|
111
|
-
font-size: 0.95em;
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
.nav-links a:hover {
|
|
115
|
-
background-color: #f0f0f0;
|
|
116
|
-
color: var(--primary);
|
|
117
|
-
transform: translateX(5px);
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
.nav-links a.active {
|
|
121
|
-
background-color: var(--primary);
|
|
122
|
-
color: white;
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
.search-box {
|
|
126
|
-
margin-bottom: 20px;
|
|
127
|
-
position: relative;
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
.search-box input {
|
|
131
|
-
width: 100%;
|
|
132
|
-
padding: 10px 15px;
|
|
133
|
-
border: 2px solid var(--border);
|
|
134
|
-
border-radius: var(--radius);
|
|
135
|
-
font-size: 14px;
|
|
136
|
-
transition: var(--transition);
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
.search-box input:focus {
|
|
140
|
-
outline: none;
|
|
141
|
-
border-color: var(--primary);
|
|
142
|
-
}
|
|
143
|
-
|
|
144
|
-
.quick-links {
|
|
145
|
-
display: grid;
|
|
146
|
-
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
|
147
|
-
gap: 15px;
|
|
148
|
-
margin: 25px 0;
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
.quick-link {
|
|
152
|
-
background: #f8f9fa;
|
|
153
|
-
padding: 20px;
|
|
154
|
-
border-radius: var(--radius);
|
|
155
|
-
text-decoration: none;
|
|
156
|
-
color: var(--text);
|
|
157
|
-
transition: var(--transition);
|
|
158
|
-
text-align: center;
|
|
159
|
-
border: 1px solid var(--border);
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
.quick-link:hover {
|
|
163
|
-
transform: translateY(-3px);
|
|
164
|
-
box-shadow: var(--shadow);
|
|
165
|
-
border-color: var(--primary);
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
.quick-link i {
|
|
169
|
-
font-size: 24px;
|
|
170
|
-
color: var(--primary);
|
|
171
|
-
margin-bottom: 10px;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
.feature-grid {
|
|
175
|
-
display: grid;
|
|
176
|
-
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
|
|
177
|
-
gap: 20px;
|
|
178
|
-
margin: 30px 0;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
.feature-card {
|
|
182
|
-
background: #f8f9fa;
|
|
183
|
-
padding: 25px;
|
|
184
|
-
border-radius: var(--radius);
|
|
185
|
-
border: 1px solid var(--border);
|
|
186
|
-
transition: var(--transition);
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
.feature-card:hover {
|
|
190
|
-
transform: translateY(-3px);
|
|
191
|
-
box-shadow: var(--shadow);
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
.feature-card h4 {
|
|
195
|
-
margin: 0 0 15px;
|
|
196
|
-
color: var(--primary);
|
|
197
|
-
display: flex;
|
|
198
|
-
align-items: center;
|
|
199
|
-
gap: 10px;
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
.feature-card p {
|
|
203
|
-
margin: 0;
|
|
204
|
-
color: var(--text-light);
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
code {
|
|
208
|
-
background-color: #f4f4f4;
|
|
209
|
-
padding: 2px 6px;
|
|
210
|
-
border-radius: 4px;
|
|
211
|
-
font-family: 'Consolas', 'Monaco', monospace;
|
|
212
|
-
font-size: 0.9em;
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
pre {
|
|
216
|
-
background-color: #f4f4f4;
|
|
217
|
-
padding: 15px;
|
|
218
|
-
border-radius: var(--radius);
|
|
219
|
-
overflow-x: auto;
|
|
220
|
-
margin: 20px 0;
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
.version-badge {
|
|
224
|
-
display: inline-block;
|
|
225
|
-
padding: 4px 8px;
|
|
226
|
-
background: var(--primary);
|
|
227
|
-
color: white;
|
|
228
|
-
border-radius: 12px;
|
|
229
|
-
font-size: 12px;
|
|
230
|
-
margin-left: 10px;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
@media (max-width: 1024px) {
|
|
234
|
-
.container {
|
|
235
|
-
flex-direction: column;
|
|
236
|
-
}
|
|
237
|
-
.sidebar {
|
|
238
|
-
position: static;
|
|
239
|
-
width: auto;
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
</style>
|
|
243
|
-
</head>
|
|
244
|
-
<body>
|
|
245
|
-
<div class="header">
|
|
246
|
-
<h1>OMD Library Documentation</h1>
|
|
247
|
-
<p>On-screen Math Display - Interactive Mathematical Expression Rendering</p>
|
|
248
|
-
<span class="version-badge">v1.0.0</span>
|
|
249
|
-
</div>
|
|
250
|
-
|
|
251
|
-
<div class="container">
|
|
252
|
-
<aside class="sidebar">
|
|
253
|
-
<div class="search-box">
|
|
254
|
-
<input type="text" placeholder="Search documentation..." id="search-docs">
|
|
255
|
-
</div>
|
|
256
|
-
|
|
257
|
-
<div class="nav-section">
|
|
258
|
-
<h3>Getting Started</h3>
|
|
259
|
-
<ul class="nav-links">
|
|
260
|
-
<li><a href="#overview" class="active">Overview</a></li>
|
|
261
|
-
<li><a href="#installation">Installation</a></li>
|
|
262
|
-
<li><a href="#quick-start">Quick Start</a></li>
|
|
263
|
-
<li><a href="../DOCUMENTATION.md">Main Documentation</a></li>
|
|
264
|
-
<li><a href="user-guide.md">User Guide</a></li>
|
|
265
|
-
</ul>
|
|
266
|
-
</div>
|
|
267
|
-
|
|
268
|
-
<div class="nav-section">
|
|
269
|
-
<h3>Core Components</h3>
|
|
270
|
-
<ul class="nav-links">
|
|
271
|
-
<li><a href="api/omdDisplay.md">omdDisplay</a></li>
|
|
272
|
-
<li><a href="api/omdCanvas.md">omdCanvas</a></li>
|
|
273
|
-
<li><a href="api/omdStepVisualizer.md">omdStepVisualizer</a></li>
|
|
274
|
-
</ul>
|
|
275
|
-
</div>
|
|
276
|
-
|
|
277
|
-
<div class="nav-section">
|
|
278
|
-
<h3>Node Types</h3>
|
|
279
|
-
<ul class="nav-links">
|
|
280
|
-
<li><a href="api/omdConstantNode.md">omdConstantNode</a></li>
|
|
281
|
-
<li><a href="api/omdVariableNode.md">omdVariableNode</a></li>
|
|
282
|
-
<li><a href="api/omdBinaryExpressionNode.md">omdBinaryExpressionNode</a></li>
|
|
283
|
-
<li><a href="api/omdUnaryExpressionNode.md">omdUnaryExpressionNode</a></li>
|
|
284
|
-
<li><a href="api/omdPowerNode.md">omdPowerNode</a></li>
|
|
285
|
-
<li><a href="api/omdSqrtNode.md">omdSqrtNode</a></li>
|
|
286
|
-
<li><a href="api/omdRationalNode.md">omdRationalNode</a></li>
|
|
287
|
-
<li><a href="api/omdEquationNode.md">omdEquationNode</a></li>
|
|
288
|
-
<li><a href="api/omdFunctionNode.md">omdFunctionNode</a></li>
|
|
289
|
-
<li><a href="api/omdParenthesisNode.md">omdParenthesisNode</a></li>
|
|
290
|
-
<li><a href="api/omdEquationSequenceNode.md">omdEquationSequenceNode</a></li>
|
|
291
|
-
</ul>
|
|
292
|
-
</div>
|
|
293
|
-
|
|
294
|
-
<div class="nav-section">
|
|
295
|
-
<h3>Utilities</h3>
|
|
296
|
-
<ul class="nav-links">
|
|
297
|
-
<li><a href="api/omdHelpers.md">omdHelpers</a></li>
|
|
298
|
-
<li><a href="api/omdConfigManager.md">omdConfigManager</a></li>
|
|
299
|
-
<li><a href="api/simplificationRules.md">Simplification Rules</a></li>
|
|
300
|
-
</ul>
|
|
301
|
-
</div>
|
|
302
|
-
</aside>
|
|
303
|
-
|
|
304
|
-
<main class="content">
|
|
305
|
-
<section id="overview">
|
|
306
|
-
<h2>Overview</h2>
|
|
307
|
-
<p>OMD (On-screen Math Display) is a powerful JavaScript library for rendering and manipulating mathematical expressions. It provides a flexible and intuitive API for creating interactive math visualizations.</p>
|
|
308
|
-
|
|
309
|
-
<div class="quick-links">
|
|
310
|
-
<a href="../examples/index.html" class="quick-link">
|
|
311
|
-
<i>🎯</i>
|
|
312
|
-
<h4>Live Examples</h4>
|
|
313
|
-
<p>See OMD in action</p>
|
|
314
|
-
</a>
|
|
315
|
-
<a href="api-reference.md" class="quick-link">
|
|
316
|
-
<i>📚</i>
|
|
317
|
-
<h4>API Reference</h4>
|
|
318
|
-
<p>Detailed API docs</p>
|
|
319
|
-
</a>
|
|
320
|
-
<a href="user-guide.md" class="quick-link">
|
|
321
|
-
<i>📖</i>
|
|
322
|
-
<h4>User Guide</h4>
|
|
323
|
-
<p>Getting started and tutorials</p>
|
|
324
|
-
</a>
|
|
325
|
-
<a href="https://github.com/jaredschiffman/omd" class="quick-link">
|
|
326
|
-
<i>💻</i>
|
|
327
|
-
<h4>GitHub</h4>
|
|
328
|
-
<p>Source code</p>
|
|
329
|
-
</a>
|
|
330
|
-
</div>
|
|
331
|
-
</section>
|
|
332
|
-
|
|
333
|
-
<section id="installation">
|
|
334
|
-
<h2>Installation</h2>
|
|
335
|
-
<p>Install via npm:</p>
|
|
336
|
-
<pre><code>npm install @omd/core</code></pre>
|
|
337
|
-
<p>Then import in your project:</p>
|
|
338
|
-
<pre><code>import { omdDisplay, omdCanvas, omdStepVisualizer } from '@omd/core';</code></pre>
|
|
339
|
-
</section>
|
|
340
|
-
|
|
341
|
-
<section id="quick-start">
|
|
342
|
-
<h2>Quick Start</h2>
|
|
343
|
-
<p>Create your first mathematical expression with just a few lines of code:</p>
|
|
344
|
-
<pre><code>// Create a renderer
|
|
345
|
-
const renderer = new omdDisplay(container);
|
|
346
|
-
|
|
347
|
-
// Render an expression
|
|
348
|
-
renderer.render('x^2 + 2x + 1');</code></pre>
|
|
349
|
-
</section>
|
|
350
|
-
|
|
351
|
-
<section id="step-visualizer">
|
|
352
|
-
<h2>Step-by-Step Visualization</h2>
|
|
353
|
-
<p>Visualize equation solving and expression simplification step by step:</p>
|
|
354
|
-
<pre><code>// Create a renderer and render the initial equation
|
|
355
|
-
const renderer = new omdDisplay(container);
|
|
356
|
-
renderer.render('2x + 3 = 7');
|
|
357
|
-
|
|
358
|
-
// Access the step-visualizer sequence
|
|
359
|
-
const stepViz = renderer.getCurrentNode(); // omdStepVisualizer instance
|
|
360
|
-
|
|
361
|
-
// Perform operations step-by-step
|
|
362
|
-
stepViz.applyEquationOperation(3, 'subtract'); // 2x + 3 = 7 → 2x = 4
|
|
363
|
-
stepViz.applyEquationOperation(2, 'divide'); // 2x = 4 → x = 2</code></pre>
|
|
364
|
-
|
|
365
|
-
<div class="feature-grid">
|
|
366
|
-
<div class="feature-card">
|
|
367
|
-
<h4>🔄 Automatic Step Generation</h4>
|
|
368
|
-
<p>Automatically generate solution steps for equations and expressions.</p>
|
|
369
|
-
</div>
|
|
370
|
-
<div class="feature-card">
|
|
371
|
-
<h4>🔍 Step Filtering</h4>
|
|
372
|
-
<p>Show or hide intermediate steps based on complexity level.</p>
|
|
373
|
-
</div>
|
|
374
|
-
<div class="feature-card">
|
|
375
|
-
<h4>📝 Step Annotations</h4>
|
|
376
|
-
<p>Add explanatory text and highlights to each step.</p>
|
|
377
|
-
</div>
|
|
378
|
-
</div>
|
|
379
|
-
</section>
|
|
380
|
-
|
|
381
|
-
<section id="features">
|
|
382
|
-
<h2>Key Features</h2>
|
|
383
|
-
<div class="feature-grid">
|
|
384
|
-
<div class="feature-card">
|
|
385
|
-
<h4>🎯 Zero Configuration</h4>
|
|
386
|
-
<p>Get started quickly with sensible defaults. No complex setup required.</p>
|
|
387
|
-
</div>
|
|
388
|
-
<div class="feature-card">
|
|
389
|
-
<h4>📐 Step-by-Step Solving</h4>
|
|
390
|
-
<p>Show mathematical work with automatic simplification and step filtering.</p>
|
|
391
|
-
</div>
|
|
392
|
-
<div class="feature-card">
|
|
393
|
-
<h4>🎨 Interactive Canvas</h4>
|
|
394
|
-
<p>Create dynamic math visualizations with drag-and-drop support.</p>
|
|
395
|
-
</div>
|
|
396
|
-
<div class="feature-card">
|
|
397
|
-
<h4>🧮 Expression Operations</h4>
|
|
398
|
-
<p>Manipulate expressions with built-in mathematical operations.</p>
|
|
399
|
-
</div>
|
|
400
|
-
<div class="feature-card">
|
|
401
|
-
<h4>🔧 Extensible</h4>
|
|
402
|
-
<p>Create custom node types and extend functionality as needed.</p>
|
|
403
|
-
</div>
|
|
404
|
-
<div class="feature-card">
|
|
405
|
-
<h4>🌈 Educational Tools</h4>
|
|
406
|
-
<p>Perfect for building interactive math learning applications.</p>
|
|
407
|
-
</div>
|
|
408
|
-
</div>
|
|
409
|
-
</section>
|
|
410
|
-
</main>
|
|
411
|
-
</div>
|
|
412
|
-
|
|
413
|
-
<script>
|
|
414
|
-
// Search functionality
|
|
415
|
-
const searchInput = document.getElementById('search-docs');
|
|
416
|
-
const navLinks = document.querySelectorAll('.nav-links a');
|
|
417
|
-
|
|
418
|
-
searchInput.addEventListener('input', (e) => {
|
|
419
|
-
const searchTerm = e.target.value.toLowerCase();
|
|
420
|
-
navLinks.forEach(link => {
|
|
421
|
-
const text = link.textContent.toLowerCase();
|
|
422
|
-
link.parentElement.style.display = text.includes(searchTerm) ? '' : 'none';
|
|
423
|
-
});
|
|
424
|
-
});
|
|
425
|
-
|
|
426
|
-
// Active link handling
|
|
427
|
-
document.querySelectorAll('.nav-links a').forEach(link => {
|
|
428
|
-
link.addEventListener('click', function(e) {
|
|
429
|
-
if (this.getAttribute('href').startsWith('#')) {
|
|
430
|
-
e.preventDefault();
|
|
431
|
-
document.querySelectorAll('.nav-links a').forEach(l => l.classList.remove('active'));
|
|
432
|
-
this.classList.add('active');
|
|
433
|
-
const target = document.querySelector(this.getAttribute('href'));
|
|
434
|
-
if (target) {
|
|
435
|
-
target.scrollIntoView({ behavior: 'smooth' });
|
|
436
|
-
}
|
|
437
|
-
}
|
|
438
|
-
});
|
|
439
|
-
});
|
|
440
|
-
|
|
441
|
-
// Handle initial active state based on hash
|
|
442
|
-
window.addEventListener('load', () => {
|
|
443
|
-
const hash = window.location.hash;
|
|
444
|
-
if (hash) {
|
|
445
|
-
const activeLink = document.querySelector(`a[href="${hash}"]`);
|
|
446
|
-
if (activeLink) {
|
|
447
|
-
document.querySelectorAll('.nav-links a').forEach(l => l.classList.remove('active'));
|
|
448
|
-
activeLink.classList.add('active');
|
|
449
|
-
}
|
|
450
|
-
}
|
|
451
|
-
});
|
|
452
|
-
</script>
|
|
453
|
-
</body>
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>OMD Library Documentation</title>
|
|
7
|
+
<style>
|
|
8
|
+
:root {
|
|
9
|
+
--primary: #3498db;
|
|
10
|
+
--primary-dark: #2980b9;
|
|
11
|
+
--text: #2c3e50;
|
|
12
|
+
--text-light: #666;
|
|
13
|
+
--bg: #f5f5f5;
|
|
14
|
+
--bg-card: #ffffff;
|
|
15
|
+
--border: #e9ecef;
|
|
16
|
+
--shadow: 0 2px 4px rgba(0,0,0,0.1);
|
|
17
|
+
--radius: 8px;
|
|
18
|
+
--transition: all 0.2s ease;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
body {
|
|
22
|
+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
|
|
23
|
+
line-height: 1.6;
|
|
24
|
+
color: var(--text);
|
|
25
|
+
margin: 0;
|
|
26
|
+
padding: 0;
|
|
27
|
+
background-color: var(--bg);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
.header {
|
|
31
|
+
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
|
|
32
|
+
color: white;
|
|
33
|
+
padding: 40px 20px;
|
|
34
|
+
text-align: center;
|
|
35
|
+
margin-bottom: 40px;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
.header h1 {
|
|
39
|
+
margin: 0;
|
|
40
|
+
font-size: 2.5em;
|
|
41
|
+
font-weight: 700;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
.header p {
|
|
45
|
+
margin: 10px 0 0;
|
|
46
|
+
opacity: 0.9;
|
|
47
|
+
font-size: 1.2em;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
.container {
|
|
51
|
+
max-width: 1400px;
|
|
52
|
+
margin: 0 auto;
|
|
53
|
+
padding: 0 20px;
|
|
54
|
+
display: flex;
|
|
55
|
+
gap: 30px;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
.sidebar {
|
|
59
|
+
flex: 0 0 300px;
|
|
60
|
+
background: var(--bg-card);
|
|
61
|
+
padding: 25px;
|
|
62
|
+
border-radius: var(--radius);
|
|
63
|
+
box-shadow: var(--shadow);
|
|
64
|
+
height: fit-content;
|
|
65
|
+
position: sticky;
|
|
66
|
+
top: 20px;
|
|
67
|
+
max-height: calc(100vh - 40px);
|
|
68
|
+
overflow-y: auto;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
.content {
|
|
72
|
+
flex: 1;
|
|
73
|
+
background: var(--bg-card);
|
|
74
|
+
padding: 30px;
|
|
75
|
+
border-radius: var(--radius);
|
|
76
|
+
box-shadow: var(--shadow);
|
|
77
|
+
min-height: 800px;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
.nav-section {
|
|
81
|
+
margin-bottom: 25px;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
.nav-section h3 {
|
|
85
|
+
color: var(--text);
|
|
86
|
+
font-size: 14px;
|
|
87
|
+
text-transform: uppercase;
|
|
88
|
+
margin: 0 0 15px;
|
|
89
|
+
padding-bottom: 8px;
|
|
90
|
+
border-bottom: 2px solid var(--border);
|
|
91
|
+
font-weight: 600;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
.nav-links {
|
|
95
|
+
list-style: none;
|
|
96
|
+
padding: 0;
|
|
97
|
+
margin: 0;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
.nav-links li {
|
|
101
|
+
margin-bottom: 5px;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
.nav-links a {
|
|
105
|
+
color: var(--text);
|
|
106
|
+
text-decoration: none;
|
|
107
|
+
display: block;
|
|
108
|
+
padding: 8px 12px;
|
|
109
|
+
border-radius: var(--radius);
|
|
110
|
+
transition: var(--transition);
|
|
111
|
+
font-size: 0.95em;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
.nav-links a:hover {
|
|
115
|
+
background-color: #f0f0f0;
|
|
116
|
+
color: var(--primary);
|
|
117
|
+
transform: translateX(5px);
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
.nav-links a.active {
|
|
121
|
+
background-color: var(--primary);
|
|
122
|
+
color: white;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
.search-box {
|
|
126
|
+
margin-bottom: 20px;
|
|
127
|
+
position: relative;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
.search-box input {
|
|
131
|
+
width: 100%;
|
|
132
|
+
padding: 10px 15px;
|
|
133
|
+
border: 2px solid var(--border);
|
|
134
|
+
border-radius: var(--radius);
|
|
135
|
+
font-size: 14px;
|
|
136
|
+
transition: var(--transition);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
.search-box input:focus {
|
|
140
|
+
outline: none;
|
|
141
|
+
border-color: var(--primary);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
.quick-links {
|
|
145
|
+
display: grid;
|
|
146
|
+
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
|
147
|
+
gap: 15px;
|
|
148
|
+
margin: 25px 0;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
.quick-link {
|
|
152
|
+
background: #f8f9fa;
|
|
153
|
+
padding: 20px;
|
|
154
|
+
border-radius: var(--radius);
|
|
155
|
+
text-decoration: none;
|
|
156
|
+
color: var(--text);
|
|
157
|
+
transition: var(--transition);
|
|
158
|
+
text-align: center;
|
|
159
|
+
border: 1px solid var(--border);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
.quick-link:hover {
|
|
163
|
+
transform: translateY(-3px);
|
|
164
|
+
box-shadow: var(--shadow);
|
|
165
|
+
border-color: var(--primary);
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
.quick-link i {
|
|
169
|
+
font-size: 24px;
|
|
170
|
+
color: var(--primary);
|
|
171
|
+
margin-bottom: 10px;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
.feature-grid {
|
|
175
|
+
display: grid;
|
|
176
|
+
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
|
|
177
|
+
gap: 20px;
|
|
178
|
+
margin: 30px 0;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
.feature-card {
|
|
182
|
+
background: #f8f9fa;
|
|
183
|
+
padding: 25px;
|
|
184
|
+
border-radius: var(--radius);
|
|
185
|
+
border: 1px solid var(--border);
|
|
186
|
+
transition: var(--transition);
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
.feature-card:hover {
|
|
190
|
+
transform: translateY(-3px);
|
|
191
|
+
box-shadow: var(--shadow);
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
.feature-card h4 {
|
|
195
|
+
margin: 0 0 15px;
|
|
196
|
+
color: var(--primary);
|
|
197
|
+
display: flex;
|
|
198
|
+
align-items: center;
|
|
199
|
+
gap: 10px;
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
.feature-card p {
|
|
203
|
+
margin: 0;
|
|
204
|
+
color: var(--text-light);
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
code {
|
|
208
|
+
background-color: #f4f4f4;
|
|
209
|
+
padding: 2px 6px;
|
|
210
|
+
border-radius: 4px;
|
|
211
|
+
font-family: 'Consolas', 'Monaco', monospace;
|
|
212
|
+
font-size: 0.9em;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
pre {
|
|
216
|
+
background-color: #f4f4f4;
|
|
217
|
+
padding: 15px;
|
|
218
|
+
border-radius: var(--radius);
|
|
219
|
+
overflow-x: auto;
|
|
220
|
+
margin: 20px 0;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
.version-badge {
|
|
224
|
+
display: inline-block;
|
|
225
|
+
padding: 4px 8px;
|
|
226
|
+
background: var(--primary);
|
|
227
|
+
color: white;
|
|
228
|
+
border-radius: 12px;
|
|
229
|
+
font-size: 12px;
|
|
230
|
+
margin-left: 10px;
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
@media (max-width: 1024px) {
|
|
234
|
+
.container {
|
|
235
|
+
flex-direction: column;
|
|
236
|
+
}
|
|
237
|
+
.sidebar {
|
|
238
|
+
position: static;
|
|
239
|
+
width: auto;
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
</style>
|
|
243
|
+
</head>
|
|
244
|
+
<body>
|
|
245
|
+
<div class="header">
|
|
246
|
+
<h1>OMD Library Documentation</h1>
|
|
247
|
+
<p>On-screen Math Display - Interactive Mathematical Expression Rendering</p>
|
|
248
|
+
<span class="version-badge">v1.0.0</span>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<div class="container">
|
|
252
|
+
<aside class="sidebar">
|
|
253
|
+
<div class="search-box">
|
|
254
|
+
<input type="text" placeholder="Search documentation..." id="search-docs">
|
|
255
|
+
</div>
|
|
256
|
+
|
|
257
|
+
<div class="nav-section">
|
|
258
|
+
<h3>Getting Started</h3>
|
|
259
|
+
<ul class="nav-links">
|
|
260
|
+
<li><a href="#overview" class="active">Overview</a></li>
|
|
261
|
+
<li><a href="#installation">Installation</a></li>
|
|
262
|
+
<li><a href="#quick-start">Quick Start</a></li>
|
|
263
|
+
<li><a href="../DOCUMENTATION.md">Main Documentation</a></li>
|
|
264
|
+
<li><a href="user-guide.md">User Guide</a></li>
|
|
265
|
+
</ul>
|
|
266
|
+
</div>
|
|
267
|
+
|
|
268
|
+
<div class="nav-section">
|
|
269
|
+
<h3>Core Components</h3>
|
|
270
|
+
<ul class="nav-links">
|
|
271
|
+
<li><a href="api/omdDisplay.md">omdDisplay</a></li>
|
|
272
|
+
<li><a href="api/omdCanvas.md">omdCanvas</a></li>
|
|
273
|
+
<li><a href="api/omdStepVisualizer.md">omdStepVisualizer</a></li>
|
|
274
|
+
</ul>
|
|
275
|
+
</div>
|
|
276
|
+
|
|
277
|
+
<div class="nav-section">
|
|
278
|
+
<h3>Node Types</h3>
|
|
279
|
+
<ul class="nav-links">
|
|
280
|
+
<li><a href="api/omdConstantNode.md">omdConstantNode</a></li>
|
|
281
|
+
<li><a href="api/omdVariableNode.md">omdVariableNode</a></li>
|
|
282
|
+
<li><a href="api/omdBinaryExpressionNode.md">omdBinaryExpressionNode</a></li>
|
|
283
|
+
<li><a href="api/omdUnaryExpressionNode.md">omdUnaryExpressionNode</a></li>
|
|
284
|
+
<li><a href="api/omdPowerNode.md">omdPowerNode</a></li>
|
|
285
|
+
<li><a href="api/omdSqrtNode.md">omdSqrtNode</a></li>
|
|
286
|
+
<li><a href="api/omdRationalNode.md">omdRationalNode</a></li>
|
|
287
|
+
<li><a href="api/omdEquationNode.md">omdEquationNode</a></li>
|
|
288
|
+
<li><a href="api/omdFunctionNode.md">omdFunctionNode</a></li>
|
|
289
|
+
<li><a href="api/omdParenthesisNode.md">omdParenthesisNode</a></li>
|
|
290
|
+
<li><a href="api/omdEquationSequenceNode.md">omdEquationSequenceNode</a></li>
|
|
291
|
+
</ul>
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
<div class="nav-section">
|
|
295
|
+
<h3>Utilities</h3>
|
|
296
|
+
<ul class="nav-links">
|
|
297
|
+
<li><a href="api/omdHelpers.md">omdHelpers</a></li>
|
|
298
|
+
<li><a href="api/omdConfigManager.md">omdConfigManager</a></li>
|
|
299
|
+
<li><a href="api/simplificationRules.md">Simplification Rules</a></li>
|
|
300
|
+
</ul>
|
|
301
|
+
</div>
|
|
302
|
+
</aside>
|
|
303
|
+
|
|
304
|
+
<main class="content">
|
|
305
|
+
<section id="overview">
|
|
306
|
+
<h2>Overview</h2>
|
|
307
|
+
<p>OMD (On-screen Math Display) is a powerful JavaScript library for rendering and manipulating mathematical expressions. It provides a flexible and intuitive API for creating interactive math visualizations.</p>
|
|
308
|
+
|
|
309
|
+
<div class="quick-links">
|
|
310
|
+
<a href="../examples/index.html" class="quick-link">
|
|
311
|
+
<i>🎯</i>
|
|
312
|
+
<h4>Live Examples</h4>
|
|
313
|
+
<p>See OMD in action</p>
|
|
314
|
+
</a>
|
|
315
|
+
<a href="api-reference.md" class="quick-link">
|
|
316
|
+
<i>📚</i>
|
|
317
|
+
<h4>API Reference</h4>
|
|
318
|
+
<p>Detailed API docs</p>
|
|
319
|
+
</a>
|
|
320
|
+
<a href="user-guide.md" class="quick-link">
|
|
321
|
+
<i>📖</i>
|
|
322
|
+
<h4>User Guide</h4>
|
|
323
|
+
<p>Getting started and tutorials</p>
|
|
324
|
+
</a>
|
|
325
|
+
<a href="https://github.com/jaredschiffman/omd" class="quick-link">
|
|
326
|
+
<i>💻</i>
|
|
327
|
+
<h4>GitHub</h4>
|
|
328
|
+
<p>Source code</p>
|
|
329
|
+
</a>
|
|
330
|
+
</div>
|
|
331
|
+
</section>
|
|
332
|
+
|
|
333
|
+
<section id="installation">
|
|
334
|
+
<h2>Installation</h2>
|
|
335
|
+
<p>Install via npm:</p>
|
|
336
|
+
<pre><code>npm install @omd/core</code></pre>
|
|
337
|
+
<p>Then import in your project:</p>
|
|
338
|
+
<pre><code>import { omdDisplay, omdCanvas, omdStepVisualizer } from '@omd/core';</code></pre>
|
|
339
|
+
</section>
|
|
340
|
+
|
|
341
|
+
<section id="quick-start">
|
|
342
|
+
<h2>Quick Start</h2>
|
|
343
|
+
<p>Create your first mathematical expression with just a few lines of code:</p>
|
|
344
|
+
<pre><code>// Create a renderer
|
|
345
|
+
const renderer = new omdDisplay(container);
|
|
346
|
+
|
|
347
|
+
// Render an expression
|
|
348
|
+
renderer.render('x^2 + 2x + 1');</code></pre>
|
|
349
|
+
</section>
|
|
350
|
+
|
|
351
|
+
<section id="step-visualizer">
|
|
352
|
+
<h2>Step-by-Step Visualization</h2>
|
|
353
|
+
<p>Visualize equation solving and expression simplification step by step:</p>
|
|
354
|
+
<pre><code>// Create a renderer and render the initial equation
|
|
355
|
+
const renderer = new omdDisplay(container);
|
|
356
|
+
renderer.render('2x + 3 = 7');
|
|
357
|
+
|
|
358
|
+
// Access the step-visualizer sequence
|
|
359
|
+
const stepViz = renderer.getCurrentNode(); // omdStepVisualizer instance
|
|
360
|
+
|
|
361
|
+
// Perform operations step-by-step
|
|
362
|
+
stepViz.applyEquationOperation(3, 'subtract'); // 2x + 3 = 7 → 2x = 4
|
|
363
|
+
stepViz.applyEquationOperation(2, 'divide'); // 2x = 4 → x = 2</code></pre>
|
|
364
|
+
|
|
365
|
+
<div class="feature-grid">
|
|
366
|
+
<div class="feature-card">
|
|
367
|
+
<h4>🔄 Automatic Step Generation</h4>
|
|
368
|
+
<p>Automatically generate solution steps for equations and expressions.</p>
|
|
369
|
+
</div>
|
|
370
|
+
<div class="feature-card">
|
|
371
|
+
<h4>🔍 Step Filtering</h4>
|
|
372
|
+
<p>Show or hide intermediate steps based on complexity level.</p>
|
|
373
|
+
</div>
|
|
374
|
+
<div class="feature-card">
|
|
375
|
+
<h4>📝 Step Annotations</h4>
|
|
376
|
+
<p>Add explanatory text and highlights to each step.</p>
|
|
377
|
+
</div>
|
|
378
|
+
</div>
|
|
379
|
+
</section>
|
|
380
|
+
|
|
381
|
+
<section id="features">
|
|
382
|
+
<h2>Key Features</h2>
|
|
383
|
+
<div class="feature-grid">
|
|
384
|
+
<div class="feature-card">
|
|
385
|
+
<h4>🎯 Zero Configuration</h4>
|
|
386
|
+
<p>Get started quickly with sensible defaults. No complex setup required.</p>
|
|
387
|
+
</div>
|
|
388
|
+
<div class="feature-card">
|
|
389
|
+
<h4>📐 Step-by-Step Solving</h4>
|
|
390
|
+
<p>Show mathematical work with automatic simplification and step filtering.</p>
|
|
391
|
+
</div>
|
|
392
|
+
<div class="feature-card">
|
|
393
|
+
<h4>🎨 Interactive Canvas</h4>
|
|
394
|
+
<p>Create dynamic math visualizations with drag-and-drop support.</p>
|
|
395
|
+
</div>
|
|
396
|
+
<div class="feature-card">
|
|
397
|
+
<h4>🧮 Expression Operations</h4>
|
|
398
|
+
<p>Manipulate expressions with built-in mathematical operations.</p>
|
|
399
|
+
</div>
|
|
400
|
+
<div class="feature-card">
|
|
401
|
+
<h4>🔧 Extensible</h4>
|
|
402
|
+
<p>Create custom node types and extend functionality as needed.</p>
|
|
403
|
+
</div>
|
|
404
|
+
<div class="feature-card">
|
|
405
|
+
<h4>🌈 Educational Tools</h4>
|
|
406
|
+
<p>Perfect for building interactive math learning applications.</p>
|
|
407
|
+
</div>
|
|
408
|
+
</div>
|
|
409
|
+
</section>
|
|
410
|
+
</main>
|
|
411
|
+
</div>
|
|
412
|
+
|
|
413
|
+
<script>
|
|
414
|
+
// Search functionality
|
|
415
|
+
const searchInput = document.getElementById('search-docs');
|
|
416
|
+
const navLinks = document.querySelectorAll('.nav-links a');
|
|
417
|
+
|
|
418
|
+
searchInput.addEventListener('input', (e) => {
|
|
419
|
+
const searchTerm = e.target.value.toLowerCase();
|
|
420
|
+
navLinks.forEach(link => {
|
|
421
|
+
const text = link.textContent.toLowerCase();
|
|
422
|
+
link.parentElement.style.display = text.includes(searchTerm) ? '' : 'none';
|
|
423
|
+
});
|
|
424
|
+
});
|
|
425
|
+
|
|
426
|
+
// Active link handling
|
|
427
|
+
document.querySelectorAll('.nav-links a').forEach(link => {
|
|
428
|
+
link.addEventListener('click', function(e) {
|
|
429
|
+
if (this.getAttribute('href').startsWith('#')) {
|
|
430
|
+
e.preventDefault();
|
|
431
|
+
document.querySelectorAll('.nav-links a').forEach(l => l.classList.remove('active'));
|
|
432
|
+
this.classList.add('active');
|
|
433
|
+
const target = document.querySelector(this.getAttribute('href'));
|
|
434
|
+
if (target) {
|
|
435
|
+
target.scrollIntoView({ behavior: 'smooth' });
|
|
436
|
+
}
|
|
437
|
+
}
|
|
438
|
+
});
|
|
439
|
+
});
|
|
440
|
+
|
|
441
|
+
// Handle initial active state based on hash
|
|
442
|
+
window.addEventListener('load', () => {
|
|
443
|
+
const hash = window.location.hash;
|
|
444
|
+
if (hash) {
|
|
445
|
+
const activeLink = document.querySelector(`a[href="${hash}"]`);
|
|
446
|
+
if (activeLink) {
|
|
447
|
+
document.querySelectorAll('.nav-links a').forEach(l => l.classList.remove('active'));
|
|
448
|
+
activeLink.classList.add('active');
|
|
449
|
+
}
|
|
450
|
+
}
|
|
451
|
+
});
|
|
452
|
+
</script>
|
|
453
|
+
</body>
|
|
454
454
|
</html>
|