squibview/docs/guides/04-cli-usage.html at main · deftio/squibview · GitHub

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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>CLI Usage Guide</title>
    <link rel="icon" type="image/svg+xml" href="data:image/svg+xml,&lt;svg xmlns=&#39;http://www.w3.org/2000/svg&#39; viewBox=&#39;0 0 32 32&#39;&gt;&lt;circle cx=&#39;16&#39; cy=&#39;16&#39; r=&#39;14&#39; fill=&#39;%23f57c00&#39; stroke=&#39;%23000&#39; stroke-width=&#39;1&#39;/&gt;&lt;path d=&#39;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&#39; fill=&#39;none&#39; stroke=&#39;%23000&#39; stroke-width=&#39;1&#39;/&gt;&lt;/svg&gt;">
  <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>CLI Usage Guide</h1><p>The SquibView CLI (<code>squibv</code>) converts Markdown files into high-quality HTML documents with full support for math, diagrams, and interactive content.</p><h2>Quick Start</h2><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Convert a markdown file to HTML</span>
npx squibv document.md

<span class="hljs-comment"># Specify output file</span>
npx squibv document.md -o output.html

<span class="hljs-comment"># Create offline-ready HTML</span>
npx squibv document.md --bundle-offline
</code></pre></div><h2>Installation Options</h2><h3>NPX (Recommended)</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># No installation required</span>
npx squibv document.md
</code></pre></div><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>Project Installation</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm install squibview
npx squibv document.md
</code></pre></div><h2>Command Syntax</h2><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">squibv [options] [file]
squibv [options] build [file]  <span class="hljs-comment"># Explicit build command</span></code></pre></div><h2>Options Reference</h2><table><thead><tr><th>Option</th><th>Short</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>--input &lt;source&gt;</code></td><td><code>-i</code></td><td>Input file or “-” for stdin</td><td>Positional arg</td></tr><tr><td><code>--output &lt;dest&gt;</code></td><td><code>-o</code></td><td>Output file or “-” for stdout</td><td><code>input.html</code></td></tr><tr><td><code>--standalone</code></td><td><code>-s</code></td><td>Self-contained HTML (default)</td><td><code>true</code></td></tr><tr><td><code>--css &lt;file&gt;</code></td><td></td><td>Custom CSS file</td><td>Built-in styles</td></tr><tr><td><code>--bundle-offline</code></td><td></td><td>Bundle all dependencies</td><td>CDN links</td></tr><tr><td><code>--watch</code></td><td><code>-w</code></td><td>Watch for changes</td><td>Off</td></tr><tr><td><code>--quiet</code></td><td></td><td>Suppress progress messages</td><td>Off</td></tr><tr><td><code>--log &lt;file&gt;</code></td><td></td><td>Log file for messages</td><td>stderr</td></tr></tbody></table><h2>Examples</h2><h3>Basic Conversion</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Convert README.md to README.html</span>
squibv README.md

<span class="hljs-comment"># Custom output name</span>
squibv README.md -o documentation.html

<span class="hljs-comment"># Read from stdin</span><span class="hljs-built_in">echo</span><span class="hljs-string">"# Hello World"</span> | squibv -i - -o output.html
</code></pre></div><h3>Advanced Features</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Bundle for offline use (larger file, no internet required)</span>
squibv document.md --bundle-offline -o standalone.html

<span class="hljs-comment"># Custom styling</span>
squibv document.md --css custom-theme.css -o styled.html

<span class="hljs-comment"># Development mode with auto-rebuild</span>
squibv document.md --watch

<span class="hljs-comment"># Quiet mode (suppress progress)</span>
squibv document.md --quiet -o output.html
</code></pre></div><h3>Batch Processing</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Convert multiple files</span><span class="hljs-keyword">for</span> file <span class="hljs-keyword">in</span> *.md; <span class="hljs-keyword">do</span>
    squibv <span class="hljs-string">"<span class="hljs-variable">$file</span>"</span> -o <span class="hljs-string">"<span class="hljs-variable">${file%.md}</span>.html"</span><span class="hljs-keyword">done</span><span class="hljs-comment"># Using find</span>
find . -name <span class="hljs-string">"*.md"</span> -<span class="hljs-built_in">exec</span> squibv {} -o {}.html \;
</code></pre></div><h2>Output Options</h2><h3>Standalone vs Regular</h3><ul><li><strong>Standalone (default)</strong>: Creates self-contained HTML with embedded CSS and CDN links</li><li><strong>Regular</strong>: Minimal HTML that requires external stylesheets</li></ul><h3>Offline Bundling</h3><p>The <code>--bundle-offline</code> option creates fully self-contained files:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">squibv document.md --bundle-offline
</code></pre></div><p><strong>Benefits:</strong></p><ul><li>Works without internet connection</li><li>Guaranteed to work in any environment</li><li>All dependencies included</li></ul><p><strong>Tradeoffs:</strong></p><ul><li>Larger file size (~4MB+)</li><li>Longer build time</li></ul><h2>Content Support</h2><h3>Markdown Features</h3><ul><li>GitHub-Flavored Markdown</li><li>Tables with alignment</li><li>Task lists</li><li>Syntax highlighting</li><li>Emoji support</li></ul><h3>Enhanced Content</h3><ul><li><strong>Math</strong>: LaTeX equations with MathJax</li><li><strong>Diagrams</strong>: Mermaid flowcharts, sequences, etc.</li><li><strong>Maps</strong>: GeoJSON and TopoJSON rendering</li><li><strong>3D Models</strong>: STL file visualization</li><li><strong>Data</strong>: CSV/TSV table rendering</li><li><strong>Graphics</strong>: SVG and ASCII-art conversion</li></ul><h3>Example Content</h3><div data-source-type="markdown"><pre><code class="hljs language-markdown" data-source-type="code" data-lang="markdown"><span class="hljs-section"># Sample Document</span><span class="hljs-section">## Math</span>
$$E = mc^2$$

<span class="hljs-section">## Diagram</span><span class="hljs-code">```mermaid
graph TD
    A[Start] --&gt; B[Process]
    B --&gt; C[End]
</span></code></pre></div><h2>Data</h2><div data-source-type="csv"><table class="squibview-data-table"><thead><tr><th>name</th><th>age</th><th>city</th></tr></thead><tbody><tr><td>John</td><td>25</td><td>NYC</td></tr><tr><td>Jane</td><td>30</td><td>LA</td></tr></tbody></table></div><h2>Code</h2><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Hello, World!'</span>);
</code></pre></div><div data-source-type="code"><pre><code class="hljs language-" data-source-type="code" data-lang="">
## Custom Styling

### Using Custom CSS
```bash
squibv document.md --css custom.css
</code></pre></div><h3>CSS File Example</h3><div data-source-type="css"><pre><code class="hljs language-css" data-source-type="code" data-lang="css"><span class="hljs-comment">/* custom.css */</span><span class="hljs-selector-tag">body</span> {
    <span class="hljs-attribute">font-family</span>: <span class="hljs-string">'Georgia'</span>, serif;
    <span class="hljs-attribute">max-width</span>: <span class="hljs-number">800px</span>;
    <span class="hljs-attribute">margin</span>: <span class="hljs-number">0</span> auto;
    <span class="hljs-attribute">padding</span>: <span class="hljs-number">2rem</span>;
}

<span class="hljs-selector-tag">h1</span> {
    <span class="hljs-attribute">color</span>: <span class="hljs-number">#2c3e50</span>;
    <span class="hljs-attribute">border-bottom</span>: <span class="hljs-number">2px</span> solid <span class="hljs-number">#3498db</span>;
}

<span class="hljs-selector-class">.squibview-data-table</span> {
    <span class="hljs-attribute">border-collapse</span>: collapse;
    <span class="hljs-attribute">width</span>: <span class="hljs-number">100%</span>;
}

<span class="hljs-selector-class">.squibview-data-table</span><span class="hljs-selector-tag">th</span>,
<span class="hljs-selector-class">.squibview-data-table</span><span class="hljs-selector-tag">td</span> {
    <span class="hljs-attribute">border</span>: <span class="hljs-number">1px</span> solid <span class="hljs-number">#ddd</span>;
    <span class="hljs-attribute">padding</span>: <span class="hljs-number">8px</span>;
    <span class="hljs-attribute">text-align</span>: left;
}
</code></pre></div><h2>Watch Mode</h2><p>Monitor files for changes and auto-rebuild:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Watch single file</span>
squibv document.md --watch

<span class="hljs-comment"># Watch with custom output</span>
squibv document.md --watch -o docs/output.html
</code></pre></div><p>Perfect for development workflows where you want live updates.</p><h2>Pipeline Integration</h2><h3>CI/CD Usage</h3><div data-source-type="yaml"><pre><code class="hljs language-yaml" data-source-type="code" data-lang="yaml"># GitHub Actions example
- name: Generate Documentation
  run: npx squibv README.md -o docs/index.html --bundle-offline
</code></pre></div><h3>Makefile Integration</h3><div data-source-type="makefile"><pre><code class="hljs language-makefile" data-source-type="code" data-lang="makefile">docs: README.md
	npx squibv README.md -o docs/index.html

.PHONY: docs
</code></pre></div><h2>Troubleshooting</h2><h3>Common Issues</h3><p><strong>File not found:</strong></p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Check file path</span><span class="hljs-built_in">ls</span> -la document.md
squibv document.md
</code></pre></div><p><strong>Permission errors:</strong></p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Check write permissions</span><span class="hljs-built_in">ls</span> -la output-directory/
</code></pre></div><p><strong>Large file warnings:</strong></p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># For large files, increase memory if needed</span>
NODE_OPTIONS=<span class="hljs-string">"--max-old-space-size=4096"</span> squibv large-document.md
</code></pre></div><h3>Logging</h3><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Enable detailed logging</span>
squibv document.md --<span class="hljs-built_in">log</span> build.log

<span class="hljs-comment"># Check log file</span><span class="hljs-built_in">cat</span> build.log
</code></pre></div><h2>Next Steps</h2><ul><li><strong><a href="../features/02-graphical-content.html">Graphical Content</a></strong> - Learn about visual features</li><li><strong><a href="../api/01-options.html">API Reference</a></strong> - Programmatic usage</li><li><strong><a href="../../examples/">Examples</a></strong> - See real-world usage examples</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>