-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
329 lines (283 loc) · 15.6 KB
/
index.html
File metadata and controls
329 lines (283 loc) · 15.6 KB
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SquibView Documentation</title>
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'><circle cx='16' cy='16' r='14' fill='%23f57c00' stroke='%23000' stroke-width='1'/><path d='M2 16h28M16 2a14 14 0 0114 14 14 14 0 01-14 14 14 14 0 01-14-14A14 14 0 0116 2zm0 0v28M9 16a7 7 0 0014 0 7 7 0 00-14 0z' fill='none' stroke='%23000' stroke-width='1'/></svg>">
<style>
/* Additional CSS */
/* SquibView CLI Generated Styles */
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif;
line-height: 1.6;
color: #333;
max-width: 900px;
margin: 0 auto;
padding: 2rem 3rem;
background-color: #fff;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.5em;
margin-bottom: 0.5em;
font-weight: 600;
line-height: 1.25;
}
h1 {
font-size: 2rem;
}
h2 {
font-size: 1.5rem;
}
h3 { font-size: 1.25rem; }
h4 { font-size: 1rem; }
h5 { font-size: 0.875rem; }
h6 { font-size: 0.85rem; color: #666; }
p { margin-bottom: 1rem; }
a {
color: #0066cc;
text-decoration: none;
}
a:hover {
color: #0066cc;
text-decoration: underline;
}
ul, ol {
margin-bottom: 1rem;
padding-left: 2rem;
}
li {
margin-bottom: 0.25rem;
}
blockquote {
margin: 1rem 0;
padding: 0.5rem 1rem;
border-left: 4px solid #ddd;
background-color: #f9f9f9;
color: #666;
}
code {
background-color: #f5f5f5;
padding: 0.2em 0.4em;
border-radius: 3px;
font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace;
font-size: 0.85em;
}
pre {
background-color: #f8f8f8;
padding: 1rem;
margin-bottom: 1rem;
overflow-x: auto;
border-radius: 4px;
}
pre code {
background-color: transparent;
padding: 0;
border-radius: 0;
}
table {
border-collapse: collapse;
width: 100%;
margin-bottom: 1rem;
}
th, td {
border: 1px solid #ddd;
padding: 0.5rem;
text-align: left;
}
th {
background-color: #f2f2f2;
font-weight: bold;
}
img {
max-width: 100%;
height: auto;
margin-bottom: 1rem;
}
hr {
border: none;
border-top: 1px solid #ddd;
margin: 2rem 0;
}
/* Badge images - inline display */
p img {
display: inline;
margin: 0 2px;
vertical-align: middle;
}
/* Math styling */
.MathJax {
overflow-x: auto;
overflow-y: hidden;
}
/* Responsive design */
@media (max-width: 768px) {
body {
padding: 1rem 1.5rem;
}
table {
font-size: 0.875rem;
}
th, td {
padding: 0.25rem;
}
}
/* Print styles */
@media print {
body {
padding: 0;
color: #000;
}
a {
color: #000;
text-decoration: underline;
}
pre, blockquote {
page-break-inside: avoid;
}
h1, h2, h3, h4, h5, h6 {
page-break-after: avoid;
}
}
</style>
<!-- Highlight.js for syntax highlighting -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<!-- Leaflet for GeoJSON/TopoJSON maps -->
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css">
<script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js"></script>
<script src="https://unpkg.com/topojson-client@3.1.0/dist/topojson-client.min.js"></script>
<!-- Three.js for STL 3D models -->
<script src="https://unpkg.com/three@0.171.0/build/three.min.js"></script>
<!-- MathJax for math rendering -->
<script>
window.MathJax = {
tex: {
inlineMath: [['$', '$'], ['\\(', '\\)']],
displayMath: [['$$', '$$'], ['\\[', '\\]']],
processEscapes: true,
processEnvironments: true
},
options: {
ignoreHtmlClass: 'tex2jax_ignore',
processHtmlClass: 'tex2jax_process'
},
svg: {
fontCache: 'global'
}
};
</script>
<script type="text/javascript" id="MathJax-script" async
src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js">
</script>
<!-- Mermaid for diagram rendering -->
<script src="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js"></script>
</head>
<body>
<div><h1>SquibView Documentation</h1><p>Welcome to the SquibView documentation! SquibView is a lightweight, flexible live editor and renderer for various content types including Markdown, HTML, CSV, and RevealJS presentations.</p><h2>Documentation Index</h2><ul><li><a href="programmers-guide.html">Programmer’s Guide</a> - Comprehensive guide to SquibView’s API and features</li><li><a href="#api-reference">API Reference</a> - Complete API reference</li><li><a href="#examples">Examples</a> - Code examples for common use cases</li><li><a href="./release-notes.html">Release Notes</a> - Version history and changes</li></ul><h2>Quick Start</h2><h3>Installation</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm install squibview
</code></pre></div><p>Or include directly in HTML:</p><div data-source-type="html"><pre><code class="hljs language-html" data-source-type="code" data-lang="html"><span class="hljs-comment"><!-- CSS --></span><span class="hljs-tag"><<span class="hljs-name">link</span><span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span><span class="hljs-attr">href</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/squibview/dist/squibview.min.css"</span>></span><span class="hljs-comment"><!-- Dependencies --></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/markdown-it/dist/markdown-it.min.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/highlight.js/lib/core.min.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/papaparse/papaparse.min.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span><span class="hljs-comment"><!-- SquibView --></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdn.jsdelivr.net/npm/squibview/dist/squibview.umd.min.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><h3>Basic Usage</h3><div data-source-type="html"><pre><code class="hljs language-html" data-source-type="code" data-lang="html"><span class="hljs-tag"><<span class="hljs-name">div</span><span class="hljs-attr">id</span>=<span class="hljs-string">"editor"</span>></span><span class="hljs-tag"></<span class="hljs-name">div</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span>></span><span class="language-javascript"><span class="hljs-keyword">const</span> editor = <span class="hljs-keyword">new</span><span class="hljs-title class_">SquibView</span>(<span class="hljs-string">'#editor'</span>, {
<span class="hljs-attr">initialContent</span>: <span class="hljs-string">'# Hello, world!\n\nThis is a **Markdown** editor.'</span>,
<span class="hljs-attr">inputContentType</span>: <span class="hljs-string">'md'</span>,
<span class="hljs-attr">initialView</span>: <span class="hljs-string">'split'</span>
});
</span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><h2>API Reference</h2><h3>Core Methods</h3><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Create a new editor</span><span class="hljs-keyword">const</span> editor = <span class="hljs-keyword">new</span><span class="hljs-title class_">SquibView</span>(<span class="hljs-string">'#editor'</span>, options);
<span class="hljs-comment">// Set content</span>
editor.<span class="hljs-title function_">setContent</span>(<span class="hljs-string">'# New content'</span>, <span class="hljs-string">'md'</span>);
<span class="hljs-comment">// Get content</span><span class="hljs-keyword">const</span> content = editor.<span class="hljs-title function_">getContent</span>();
<span class="hljs-comment">// Change view mode</span>
editor.<span class="hljs-title function_">setView</span>(<span class="hljs-string">'split'</span>); <span class="hljs-comment">// 'src', 'html', or 'split'</span><span class="hljs-comment">// Working with selections</span>
editor.<span class="hljs-title function_">onTextSelected</span>(<span class="hljs-function"><span class="hljs-params">selectionData</span> =></span> {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`Selected: <span class="hljs-subst">${selectionData.text}</span>`</span>);
});
<span class="hljs-comment">// Replace selected text</span>
editor.<span class="hljs-title function_">replaceSelectedText</span>(<span class="hljs-string">'replacement'</span>, selectionData);
<span class="hljs-comment">// Set a text replacement handler</span>
editor.<span class="hljs-property">onReplaceSelectedText</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params">selectionData</span>) {
<span class="hljs-comment">// Process and optionally return replacement text</span>
};
<span class="hljs-comment">// Undo/redo</span>
editor.<span class="hljs-title function_">revisionUndo</span>();
editor.<span class="hljs-title function_">revisionRedo</span>();
</code></pre></div><p>See the <a href="programmers-guide.html">Programmer’s Guide</a> for complete API details.</p><h2>Examples</h2><h3>Markdown Editor</h3><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> editor = <span class="hljs-keyword">new</span><span class="hljs-title class_">SquibView</span>(<span class="hljs-string">'#editor'</span>, {
<span class="hljs-attr">initialContent</span>: <span class="hljs-string">'# Hello world'</span>,
<span class="hljs-attr">inputContentType</span>: <span class="hljs-string">'md'</span>,
<span class="hljs-attr">initialView</span>: <span class="hljs-string">'split'</span>
});
</code></pre></div><h3>Text Selection and Replacement</h3><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Option 1: Using callbacks</span>
editor.<span class="hljs-title function_">onTextSelected</span>(<span class="hljs-function"><span class="hljs-params">selectionData</span> =></span> {
<span class="hljs-keyword">if</span> (selectionData.<span class="hljs-property">text</span>.<span class="hljs-title function_">toLowerCase</span>() === <span class="hljs-string">'todo'</span>) {
editor.<span class="hljs-title function_">replaceSelectedText</span>(<span class="hljs-string">'DONE'</span>, selectionData);
}
});
<span class="hljs-comment">// Option 2: Using the replacement handler</span>
editor.<span class="hljs-property">onReplaceSelectedText</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params">selectionData</span>) {
<span class="hljs-keyword">if</span> (selectionData.<span class="hljs-property">text</span>.<span class="hljs-title function_">toLowerCase</span>() === <span class="hljs-string">'todo'</span>) {
<span class="hljs-keyword">return</span><span class="hljs-string">'DONE'</span>;
}
<span class="hljs-comment">// Return undefined to not replace anything</span>
};
</code></pre></div><h3>CSV Table Editor</h3><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> csvData = <span class="hljs-string">'Name,Age,City\nJohn,30,New York\nJane,25,San Francisco'</span>;
<span class="hljs-keyword">const</span> editor = <span class="hljs-keyword">new</span><span class="hljs-title class_">SquibView</span>(<span class="hljs-string">'#editor'</span>, {
<span class="hljs-attr">initialContent</span>: csvData,
<span class="hljs-attr">inputContentType</span>: <span class="hljs-string">'csv'</span>,
<span class="hljs-attr">initialView</span>: <span class="hljs-string">'split'</span>
});
</code></pre></div><h3>Presentation Editor</h3><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> slides = <span class="hljs-string">`# My Presentation
First slide content
---
## Second Slide
- Bullet points
- More points
---
## Thank You
Questions?`</span>;
<span class="hljs-keyword">const</span> editor = <span class="hljs-keyword">new</span><span class="hljs-title class_">SquibView</span>(<span class="hljs-string">'#editor'</span>, {
<span class="hljs-attr">initialContent</span>: slides,
<span class="hljs-attr">inputContentType</span>: <span class="hljs-string">'reveal'</span>,
<span class="hljs-attr">initialView</span>: <span class="hljs-string">'html'</span>
});
</code></pre></div><h2>Community and Support</h2><ul><li><a href="https://github.com/deftio/squibview">GitHub Repository</a></li><li><a href="https://github.com/deftio/squibview/issues">Issue Tracker</a></li><li><a href="../examples/">Examples Directory</a></li></ul><h2>License</h2><p>SquibView is released under the MIT License. See the <a href="../LICENSE.txt">LICENSE</a> file for details.</p></div>
<script>
// Initialize MathJax after page load
document.addEventListener('DOMContentLoaded', function() {
if (window.MathJax && window.MathJax.typesetPromise) {
window.MathJax.typesetPromise().catch(function(err) {
console.warn('MathJax typesetting failed:', err);
});
}
});
</script>
<script>
// Initialize Mermaid after page load
document.addEventListener('DOMContentLoaded', function() {
if (window.mermaid) {
try {
window.mermaid.initialize({
startOnLoad: false,
theme: 'default',
securityLevel: 'loose',
fontFamily: 'inherit'
});
// Manually render all mermaid diagrams
const mermaidElements = document.querySelectorAll('.mermaid');
mermaidElements.forEach(function(element, index) {
const id = 'mermaid-' + index;
element.id = id;
try {
window.mermaid.render(id + '-svg', element.textContent, function(svgCode) {
element.innerHTML = svgCode;
});
} catch (err) {
console.warn('Mermaid rendering failed for element', index, ':', err);
// Fallback: show the text content
element.innerHTML = '<pre>' + element.textContent + '</pre>';
}
});
} catch (err) {
console.warn('Mermaid initialization failed:', err);
}
}
});
</script>
</body>
</html>