-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path02-installation.html
More file actions
287 lines (254 loc) · 17.6 KB
/
02-installation.html
File metadata and controls
287 lines (254 loc) · 17.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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation Guide</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>Installation Guide</h1><p>SquibView provides multiple build types to fit different development environments and use cases.</p><h2>Build Types Overview</h2><table><thead><tr><th>Build Type</th><th>Best For</th><th>Dependencies</th><th>Size</th><th>Autoload Support</th></tr></thead><tbody><tr><td><strong>Standard (ESM/UMD)</strong></td><td>Most projects</td><td>markdown-it bundled</td><td>~245KB</td><td>✅ Yes</td></tr><tr><td><strong>Lean (ESM/UMD)</strong></td><td>Custom bundlers</td><td>External</td><td>~126KB</td><td>✅ Yes</td></tr><tr><td><strong>Standalone</strong></td><td>Offline/airgapped</td><td>Everything bundled</td><td>~3.6MB</td><td>Not needed</td></tr></tbody></table><p>All builds support the <code>autoload_deps</code> option for automatic library loading from CDN.</p><h2>NPM Installation</h2><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm install squibview
</code></pre></div><h3>ESM (Recommended for Modern Projects)</h3><p>Use this with modern bundlers that handle dependencies:</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">import</span> { <span class="hljs-title class_">SquibView</span> } <span class="hljs-keyword">from</span><span class="hljs-string">'squibview'</span>;
<span class="hljs-keyword">import</span><span class="hljs-string">'squibview/dist/squibview.min.css'</span>;
<span class="hljs-keyword">const</span> editor = <span class="hljs-keyword">new</span><span class="hljs-title class_">SquibView</span>({
<span class="hljs-attr">element</span>: <span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'editor'</span>),
<span class="hljs-attr">content</span>: <span class="hljs-string">'# Hello World'</span>
});
</code></pre></div><p><strong>When to use:</strong> You have a build step with Vite, Webpack, or similar bundlers.</p><h3>UMD (Legacy Browser Support)</h3><p>For projects without modern bundling:</p><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">link</span><span class="hljs-attr">rel</span>=<span class="hljs-string">"stylesheet"</span><span class="hljs-attr">href</span>=<span class="hljs-string">"node_modules/squibview/dist/squibview.min.css"</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"node_modules/squibview/dist/squibview.umd.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><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-attr">element</span>: <span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'editor'</span>),
<span class="hljs-attr">content</span>: <span class="hljs-string">'# Hello World'</span>
});
</span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><p><strong>When to use:</strong> Legacy projects or when you want to include SquibView as a simple script tag.</p><h2>CDN Usage</h2><h3>Standard Build with Autoload (Recommended)</h3><p>Zero configuration with automatic library loading:</p><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">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://unpkg.com/squibview/dist/squibview.min.css"</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">type</span>=<span class="hljs-string">"module"</span>></span><span class="language-javascript"><span class="hljs-keyword">import</span><span class="hljs-title class_">SquibView</span><span class="hljs-keyword">from</span><span class="hljs-string">'https://unpkg.com/squibview/dist/squibview.esm.min.js'</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>: <span class="hljs-string">'# Hello\n\n```mermaid\ngraph TD\n A --> B\n```'</span>,
<span class="hljs-attr">autoload_deps</span>: { <span class="hljs-attr">all</span>: <span class="hljs-literal">true</span> } <span class="hljs-comment">// Enable autoloading</span>
});
</span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><p><strong>When to use:</strong> Most projects - libraries load from CDN only when content needs them.</p><h3>Standalone Build (Offline-Ready)</h3><p>Everything bundled together - perfect for offline environments:</p><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">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://unpkg.com/squibview/dist/squibview.min.css"</span>></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://unpkg.com/squibview/dist/squibview.standalone.min.js"</span>></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><p><strong>When to use:</strong> Offline apps, airgapped environments, or when CDN access is restricted.</p><h3>ESM Build (Default - v1.0.15+)</h3><p>As of v1.0.15, markdown-it is bundled by default. No import maps needed!</p><div data-source-type="html"><pre><code class="hljs language-html" data-source-type="code" data-lang="html"><span class="hljs-comment"><!-- SquibView 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://unpkg.com/squibview/dist/squibview.min.css"</span>></span><span class="hljs-comment"><!-- Optional external dependencies for advanced features --></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">src</span>=<span class="hljs-string">"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.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@11/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">type</span>=<span class="hljs-string">"module"</span>></span><span class="language-javascript"><span class="hljs-comment">// Import SquibView - markdown-it is now bundled!</span><span class="hljs-keyword">import</span><span class="hljs-title class_">SquibView</span><span class="hljs-keyword">from</span><span class="hljs-string">'https://unpkg.com/squibview/dist/squibview.esm.min.js'</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><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><h3>ESM-Lean Build (Advanced Users)</h3><p>If you’re managing your own dependencies:</p><div data-source-type="html"><pre><code class="hljs language-html" data-source-type="code" data-lang="html"><span class="hljs-comment"><!-- Import map for external dependencies --></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">type</span>=<span class="hljs-string">"importmap"</span>></span><span class="language-javascript">
{
<span class="hljs-string">"imports"</span>: {
<span class="hljs-string">"markdown-it"</span>: <span class="hljs-string">"https://esm.sh/markdown-it@14.1.0"</span>,
<span class="hljs-string">"tiny-emitter"</span>: <span class="hljs-string">"https://esm.sh/tiny-emitter@2.1.0"</span>,
<span class="hljs-string">"diff-match-patch"</span>: <span class="hljs-string">"https://esm.sh/diff-match-patch@1.0.5"</span>
}
}
</span><span class="hljs-tag"></<span class="hljs-name">script</span>></span><span class="hljs-comment"><!-- SquibView ESM-lean build --></span><span class="hljs-tag"><<span class="hljs-name">script</span><span class="hljs-attr">type</span>=<span class="hljs-string">"module"</span>></span><span class="language-javascript"><span class="hljs-keyword">import</span><span class="hljs-title class_">SquibView</span><span class="hljs-keyword">from</span><span class="hljs-string">'https://unpkg.com/squibview/dist/squibview.esm-lean.min.js'</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><span class="hljs-tag"></<span class="hljs-name">script</span>></span></code></pre></div><h2>CLI Installation</h2><h3>Global Installation</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm install -g squibview
squibv document.md
</code></pre></div><h3>Local Usage (Recommended)</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npx squibv document.md
</code></pre></div><h3>Project Installation</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm install --save-dev squibview
npx squibv document.md
</code></pre></div><h2>Dependency Requirements</h2><p>SquibView uses these external libraries for enhanced functionality:</p><ul><li><strong>Highlight.js</strong> - Syntax highlighting</li><li><strong>MathJax</strong> - Math equation rendering</li><li><strong>Mermaid</strong> - Diagram rendering</li><li><strong>Leaflet</strong> - Map rendering (GeoJSON/TopoJSON)</li><li><strong>Three.js</strong> - 3D model rendering (STL files)</li></ul><h3>Choosing the Right Build</h3><p><strong>Autoload builds</strong> (v1.0.18+) - Recommended for most users:</p><ul><li>Zero configuration - libraries load from CDN when needed</li><li>Fast initial load (~258KB), features load on-demand</li><li>Perfect balance of simplicity and performance</li></ul><p><strong>Standard builds</strong> (ESM/UMD) include core dependencies:</p><ul><li>Medium bundle size (~245KB)</li><li>No CDN dependency after initial load</li><li>Good for projects with custom bundling</li></ul><p><strong>Lean builds</strong> (ESM-lean/UMD-lean) for advanced users:</p><ul><li>Smallest bundle size (~126KB)</li><li>Full control over dependency versions</li><li>Requires managing external dependencies</li></ul><p><strong>Standalone builds</strong> include everything:</p><ul><li>Works completely offline</li><li>No external dependencies ever</li><li>Largest file size (~3.6MB)</li></ul><h2>Next Steps</h2><ul><li><strong><a href="./03-basic-usage.html">Basic Usage</a></strong> - Learn how to use SquibView</li><li><strong><a href="./04-cli-usage.html">CLI Usage</a></strong> - Master the command-line interface</li></ul></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>