squibview/docs/README.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
<!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,&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 Documentation</h1><p>Welcome to the SquibView documentation! This directory contains comprehensive documentation for the SquibView library.</p><h2>Documentation Structure</h2><h3>📚 <a href="./api/">API Reference</a></h3><p>Complete API documentation for SquibView classes and methods.</p><ul><li><a href="./api/SquibView.html">SquibView Class</a> - Main editor class</li><li><a href="./api/methods.html">Methods</a> - All public methods</li><li><a href="./api/options.html">Options</a> - Configuration options</li><li><a href="./api/events.html">Events</a> - Event system reference</li></ul><h3>📖 <a href="./guides/">Guides</a></h3><p>Step-by-step guides and tutorials.</p><ul><li><a href="./guides/getting-started.html">Getting Started</a></li><li><a href="./guides/installation.html">Installation</a></li><li><a href="./guides/headless-mode.html">Headless Mode</a> - Using SquibView without UI</li><li><a href="./programmers-guide.html">Programmer’s Guide</a> - Comprehensive usage guide</li></ul><h3>🔧 <a href="./development/">Development</a></h3><p>Documentation for contributors and developers.</p><ul><li><a href="./development/DEVELOPMENT.html">Development Guide</a></li><li><a href="./development/CONTRIBUTING.html">Contributing</a></li><li><a href="./development/do-release.html">Release Process</a></li></ul><h3>📝 <a href="./examples/">Examples</a></h3><p>Code examples and demos.</p><ul><li><a href="../examples/">Basic Examples</a> - HTML example files</li><li><a href="./examples/gif-demo-content.html">Demo Content</a></li><li><a href="./examples/demos.html">Demo Guide</a></li></ul><h3>🖥️ <a href="./cli/">CLI Documentation</a></h3><p>Command-line interface documentation.</p><ul><li><a href="./cli/CLI.html">CLI Guide</a> - Using the squibv CLI tool</li><li><a href="./cli/README.html">CLI Readme</a> - Quick reference</li></ul><h3>📋 Other Documentation</h3><ul><li><a href="./release-notes.html">Release Notes</a> - Complete version history and changelog</li><li><a href="./selection-api.html">Selection API</a> - Working with text selection</li><li><a href="./umd-build-configuration.html">UMD Build Configuration</a> - Build setup guide</li></ul><h2>Quick Links</h2><ul><li><strong>Repository:</strong><a href="https://github.com/deftio/squibview">GitHub</a></li><li><strong>NPM Package:</strong><a href="https://www.npmjs.com/package/squibview">squibview</a></li><li><strong>CDN:</strong> Available via jsDelivr and unpkg</li></ul><h2>Getting Started</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><h3>Basic Usage</h3><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.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-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>CDN Usage</h3><div data-source-type="html"><pre><code class="hljs language-html" data-source-type="code" data-lang="html"><span class="hljs-comment">&lt;!-- CSS --&gt;</span><span class="hljs-tag">&lt;<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>&gt;</span><span class="hljs-comment">&lt;!-- JavaScript --&gt;</span><span class="hljs-tag">&lt;<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>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span><span class="hljs-tag">&lt;<span class="hljs-name">script</span>&gt;</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><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></code></pre></div><h2>Features</h2><ul><li><strong>Multi-format Support:</strong> Markdown, HTML, RevealJS presentations, CSV/TSV</li><li><strong>Live Preview:</strong> Real-time rendering with split-screen view</li><li><strong>Syntax Highlighting:</strong> Code block highlighting with highlight.js</li><li><strong>Diagrams:</strong> Mermaid diagram support</li><li><strong>Math:</strong> LaTeX math rendering with MathJax</li><li><strong>Maps:</strong> GeoJSON/TopoJSON visualization</li><li><strong>3D Models:</strong> STL file viewing</li><li><strong>Revision History:</strong> Undo/redo with diff-based history</li><li><strong>Copy Support:</strong> Smart clipboard operations</li><li><strong>Line Numbers:</strong> Optional line numbering</li><li><strong>Plugin System:</strong> Extensible renderer architecture</li></ul><h2>Version</h2><p>See [release-notes]/(./docs/release-notes.md)</p><h2>License</h2><p>MIT License - See <a href="../LICENSE.txt">LICENSE</a> for details</p><h2>Support</h2><p>For issues, questions, or contributions, please visit the <a href="https://github.com/deftio/squibview">GitHub repository</a>.</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>