squibview/docs/development/DEVELOPMENT.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
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>SquibView Development 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>SquibView Development Guide</h1><p>This guide provides information about different ways to develop and test SquibView.</p><h2>Development Environments</h2><p>There are several ways to develop SquibView, depending on your preferences and needs:</p><h3>1. Simple HTTP Server</h3><p>You can use Python’s built-in HTTP server for simple development:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash"><span class="hljs-comment"># Python 3</span>
python -m http.server

<span class="hljs-comment"># Python 2</span>
python -m SimpleHTTPServer
</code></pre></div><p>Run this command from the project root directory, then open your browser to <a href="http://localhost:8000/dev/debug.html">http://localhost:8000/dev/debug.html</a> (or any other debug file).</p><h4>Import Maps</h4><p>All debug HTML files now include import maps to properly resolve ES module dependencies:</p><div data-source-type="html"><pre><code class="hljs language-html" data-source-type="code" data-lang="html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span><span class="hljs-attr">type</span>=<span class="hljs-string">"importmap"</span>&gt;</span><span class="language-javascript">
{
  <span class="hljs-string">"imports"</span>: {
    <span class="hljs-string">"tiny-emitter"</span>: <span class="hljs-string">"https://unpkg.com/tiny-emitter@2.1.0/dist/tinyemitter.min.js"</span>,
    <span class="hljs-string">"diff-match-patch"</span>: <span class="hljs-string">"https://unpkg.com/diff-match-patch@1.0.5/index.js"</span>,
    <span class="hljs-string">"turndown"</span>: <span class="hljs-string">"https://unpkg.com/turndown@7.1.2/dist/turndown.js"</span>
  }
}
</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre></div><p>These import maps allow browsers to resolve bare module specifiers like <code>import TinyEmitter from "tiny-emitter"</code> to the actual URL from which to fetch the module.</p><h3>2. Vite Development Server</h3><p>For a more modern development experience with hot module replacement (HMR):</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm run dev
</code></pre></div><p>This command starts a Vite development server with HMR enabled. When you make changes to the source files, they will be automatically reflected in the browser without a full page reload.</p><h3>3. Advanced Development Environment</h3><p>For the most comprehensive development experience:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm run dev:hmr
</code></pre></div><p>This command starts a custom development server with additional features:</p><ul><li>Live-reload for all file changes</li><li>Development UI with test runners</li><li>Multiple content type testing</li></ul><h2>Debug Files</h2><p>The <code>/dev</code> directory contains several debug HTML files for different purposes:</p><ul><li><code>debug.html</code> - Basic editor with Markdown content</li><li><code>debug-adv.html</code> - Advanced editor with additional controls</li><li><code>debug-csv.html</code> - Editor configured for CSV content</li><li><code>debug-slides.html</code> - Editor configured for Reveal.js presentations</li><li><code>debug-dev.html</code> - Modern development environment with HMR</li></ul><h2>Testing During Development</h2><p>To run tests during development:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm <span class="hljs-built_in">test</span></code></pre></div><p>For a specific test file or pattern:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">jest tests/SquibView.test.js --testNamePattern=<span class="hljs-string">"pattern"</span></code></pre></div><h2>Building for Distribution</h2><p>To build the distribution files:</p><div data-source-type="bash"><pre><code class="hljs language-bash" data-source-type="code" data-lang="bash">npm run build
</code></pre></div><p>This command creates minified and non-minified versions of SquibView in the <code>/dist</code> directory, including ESM, UMD, and standalone versions.</p><h2>Module Resolution</h2><p>SquibView uses ES modules with named exports. When developing locally, module resolution is handled in one of three ways:</p><ol><li>Import maps (for simple HTTP servers)</li><li>Vite’s built-in module resolution (for <code>npm run dev</code>)</li><li>Custom module resolution (for <code>npm run dev:hmr</code>)</li></ol><h2>Development Tips</h2><ul><li>Use the browser console to interact with the editor instance: <code>window.editor</code></li><li>Check the editor version with: <code>SquibView.version.version</code></li><li>Test different content types using the sample files in the <code>/dev</code> directory</li><li>Use the Selection API for interactive features: <code>editor.onTextSelected(callback)</code></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>