typemagic/guide.html at main · sunkencity999/typemagic · 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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>TypeMagic User Guide</title>
  <style>
    /* Font Faces */
    @font-face {
        font-family: 'Calendas Plus';
        src: url('fonts/calendas_plus_regular.woff2') format('woff2');
        font-weight: normal;
        font-style: normal;
    }
    @font-face {
        font-family: 'Calendas Plus';
        src: url('fonts/calendas_plus_bold.woff2') format('woff2');
        font-weight: bold;
        font-style: normal;
    }

    /* Variables */
    :root {
        --primary-color: #1f2937; /* Charcoal */
        --secondary-color: #374151; /* Lighter Charcoal */
        --accent-color: #e07a5f; /* Burnt Sienna */
        --text-color: #111827;
        --bg-color: #ffffff;
        --font-main: 'Calendas Plus', serif;
        --font-ui: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
    }

    * {
      margin: 0;
      padding: 0;
      box-sizing: border-box;
    }

    body {
      font-family: var(--font-ui);
      line-height: 1.6;
      color: var(--text-color);
      background: linear-gradient(135deg, #f9fafb 0%, #f3f4f6 100%);
      padding: 40px 20px;
    }

    .container {
      max-width: 900px;
      margin: 0 auto;
      background: white;
      border-radius: 20px;
      box-shadow: 0 10px 40px rgba(0, 0, 0, 0.05);
      overflow: hidden;
      border: 1px solid rgba(0, 0, 0, 0.05);
    }

    .header {
      background: var(--primary-color);
      color: white;
      padding: 60px 40px;
      text-align: center;
    }

    .header h1 {
      font-family: var(--font-main);
      font-size: 3rem;
      font-weight: 700;
      margin-bottom: 10px;
    }

    .header .subtitle {
      font-size: 1.2rem;
      opacity: 0.9;
      font-weight: 500;
    }

    .content {
      padding: 50px 40px;
    }

    .section {
      margin-bottom: 50px;
    }

    .section:last-child {
      margin-bottom: 0;
    }

    h2 {
      font-family: var(--font-main);
      font-size: 2rem;
      color: var(--primary-color);
      margin-bottom: 20px;
      padding-bottom: 10px;
      border-bottom: 2px solid #e5e7eb;
    }

    h3 {
      font-size: 1.3rem;
      color: var(--secondary-color);
      margin: 30px 0 15px 0;
      font-weight: 700;
    }

    p {
      margin-bottom: 15px;
      color: #4b5563;
    }

    .key-feature {
      background: #f9fafb;
      border-left: 4px solid var(--accent-color);
      padding: 20px;
      margin: 20px 0;
      border-radius: 8px;
      border: 1px solid #e5e7eb;
    }

    .key-feature strong {
      color: var(--primary-color);
      font-size: 1.1rem;
      display: block;
      margin-bottom: 8px;
    }

    ul, ol {
      margin: 15px 0 15px 30px;
    }

    li {
      margin-bottom: 10px;
      color: #4b5563;
    }

    li strong {
        color: var(--primary-color);
    }

    .workflow {
      background: white;
      padding: 25px;
      border-radius: 12px;
      margin: 20px 0;
      border: 1px solid #e5e7eb;
      box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.05);
    }

    .workflow-step {
      display: flex;
      align-items: flex-start;
      margin-bottom: 20px;
    }

    .workflow-step:last-child {
      margin-bottom: 0;
    }

    .step-number {
      background: var(--primary-color);
      color: white;
      width: 32px;
      height: 32px;
      border-radius: 50%;
      display: flex;
      align-items: center;
      justify-content: center;
      font-weight: bold;
      margin-right: 15px;
      flex-shrink: 0;
      font-family: var(--font-ui);
      box-shadow: 0 2px 4px rgba(0,0,0,0.1);
    }

    .step-content {
      flex: 1;
    }

    .step-content strong {
        color: var(--primary-color);
    }

    .tip-box {
      background: #fff7ed; /* Light orange/sienna tint */
      border-left: 4px solid var(--accent-color);
      padding: 20px;
      margin: 20px 0;
      border-radius: 8px;
    }

    .tip-box strong {
      color: #9a3412;
    }

    .shortcut-key {
      background: white;
      padding: 4px 8px;
      border-radius: 6px;
      font-family: var(--font-ui);
      font-weight: 600;
      font-size: 0.9rem;
      border: 1px solid #d1d5db;
      display: inline-block;
      margin: 0 2px;
      color: var(--primary-color);
      box-shadow: 0 1px 2px rgba(0,0,0,0.05);
    }

    .comparison-table {
      width: 100%;
      border-collapse: separate;
      border-spacing: 0;
      margin: 20px 0;
      border-radius: 8px;
      overflow: hidden;
      border: 1px solid #e5e7eb;
    }

    .comparison-table th,
    .comparison-table td {
      padding: 15px;
      text-align: left;
      border-bottom: 1px solid #e5e7eb;
    }

    .comparison-table th {
      background: #f9fafb;
      color: var(--primary-color);
      font-weight: 700;
      border-bottom: 2px solid #e5e7eb;
    }

    .comparison-table tr:last-child td {
        border-bottom: none;
    }

    .comparison-table tr:hover td {
      background: #f9fafb;
    }

    .footer {
      background: #f9fafb;
      padding: 30px 40px;
      text-align: center;
      color: #9ca3af;
      border-top: 1px solid #e5e7eb;
      font-size: 0.9rem;
    }

    .footer p {
      margin-bottom: 10px;
      color: #6b7280;
    }

    .footer strong {
        color: var(--primary-color);
    }

    code {
      background: #f3f4f6;
      padding: 2px 6px;
      border-radius: 4px;
      font-family: 'SF Mono', 'Monaco', 'Courier New', monospace;
      font-size: 0.9rem;
      color: var(--accent-color);
      border: 1px solid #e5e7eb;
    }

    @media (max-width: 768px) {
      .header {
        padding: 40px 20px;
      }

      .header h1 {
        font-size: 2rem;
      }

      .content {
        padding: 30px 20px;
      }

      h2 {
        font-size: 1.5rem;
      }

      h3 {
        font-size: 1.2rem;
      }
    }
  </style>
</head>
<body>
  <div class="container">
    <div class="header">
      <h1>TypeMagic User Guide</h1>
      <p class="subtitle">AI-Powered Text Correction & Formatting for Chrome</p>
    </div>

    <div class="content">
      <!-- Getting Started -->
      <div class="section">
        <h2>Getting Started</h2>
        <p>TypeMagic is designed to be intuitive and powerful. Whether you're writing emails, posts, or documents, TypeMagic helps you communicate more effectively by automatically correcting errors while preserving your unique voice.</p>

        <div class="key-feature">
          <strong>The Magic Shortcut</strong>
          <p>Press <span class="shortcut-key">Cmd+Option+T</span> on Mac or <span class="shortcut-key">Ctrl+Alt+T</span> on Windows/Linux to instantly correct text anywhere on the web. This is the fastest and most seamless way to use TypeMagic.</p>
        </div>
      </div>

      <!-- Keyboard Shortcut Workflow -->
      <div class="section">
        <h2>Quick Start: Keyboard Shortcut</h2>
        <p>The keyboard shortcut is the recommended way to use TypeMagic for maximum productivity.</p>

        <div class="workflow">
          <div class="workflow-step">
            <div class="step-number">1</div>
            <div class="step-content">
              <strong>Click in any text field</strong> or <strong>select text</strong> you want to correct (email compose, comment box, text area, etc.)
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">2</div>
            <div class="step-content">
              <strong>Press the magic shortcut:</strong> <span class="shortcut-key">Cmd+Option+T</span> on Mac or <span class="shortcut-key">Ctrl+Alt+T</span> on Windows/Linux
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">3</div>
            <div class="step-content">
              <strong>Wait a moment</strong> while TypeMagic processes your text (usually 1-3 seconds)
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">4</div>
            <div class="step-content">
              <strong>Your text is corrected instantly</strong> in place, ready to send or continue editing
            </div>
          </div>
        </div>

        <div class="tip-box">
          <strong>Pro Tip:</strong> The keyboard shortcut (<span class="shortcut-key">Cmd+Option+T</span> / <span class="shortcut-key">Ctrl+Alt+T</span>) uses the "Keep My Voice" tone by default, which fixes errors while preserving your writing style. For other tones, use the popup interface.
        </div>
      </div>

      <!-- Tone Adjustment -->
      <div class="section">
        <h2>Tone Adjustment</h2>
        <p>TypeMagic offers three tone modes to match different contexts and audiences. Access these through the popup interface.</p>

        <h3>Keep My Voice</h3>
        <p>This is the default mode and is perfect for most situations. It corrects all spelling, grammar, and punctuation errors while preserving your unique voice, personality, and informal language.</p>
        <ul>
          <li>Fixes all spelling errors</li>
          <li>Fixes all grammar and punctuation errors</li>
          <li>Preserves informal language like "gonna", "kinda", "lol"</li>
          <li>Maintains your personality and word choice</li>
          <li>Adds paragraph breaks if text is one long wall</li>
        </ul>

        <h3>More Professional</h3>
        <p>Use this mode when writing business emails, formal documents, or professional communications.</p>
        <ul>
          <li>Fixes all errors</li>
          <li>Replaces casual language with professional equivalents ("gonna" becomes "going to")</li>
          <li>Removes slang and overly casual expressions</li>
          <li>Maintains a respectful, business-appropriate tone</li>
          <li>Preserves your core message</li>
        </ul>

        <h3>More Casual</h3>
        <p>Perfect for making formal text more conversational and approachable.</p>
        <ul>
          <li>Fixes all errors</li>
          <li>Makes formal language more conversational ("utilize" becomes "use")</li>
          <li>Adds warmth and approachability</li>
          <li>Keeps text natural and friendly</li>
          <li>Preserves your original meaning</li>
        </ul>
      </div>

      <!-- Bulletize Feature -->
      <div class="section">
        <h2>Convert to Bullets</h2>
        <p>The "Convert to Bullets" feature transforms paragraphs into clean, organized bullet points while fixing errors. This is perfect for:</p>
        <ul>
          <li>Meeting notes and action items</li>
          <li>Converting prose into presentations</li>
          <li>Creating lists from stream-of-consciousness writing</li>
          <li>Making information more scannable and digestible</li>
        </ul>

        <p>To use this feature, paste your text into the popup textarea and click the "Convert to Bullets" button.</p>
      </div>

      <!-- Summarize Feature -->
      <div class="section">
        <h2>Summarize</h2>
        <p>The "Summarize" feature creates concise, professional summaries of longer text while fixing any errors. The AI condenses your text to 20-30% of its original length (typically 2-5 sentences) while preserving all key information.</p>

        <p>Perfect for:</p>
        <ul>
          <li>Creating executive summaries of long documents</li>
          <li>Condensing lengthy emails into key points</li>
          <li>Generating TL;DR (Too Long; Didn't Read) versions</li>
          <li>Getting quick overviews before meetings</li>
          <li>Sharing highlights with stakeholders</li>
          <li>Creating brief descriptions for reports</li>
        </ul>

        <p>The summary is written as flowing paragraphs (not bullets) in clear, professional language. To use this feature, paste your text into the popup textarea and click the "Summarize" button.</p>
      </div>

      <!-- Use Cases -->
      <div class="section">
        <h2>Best Practices & Use Cases</h2>

        <h3>Email Communication</h3>
        <p>Draft emails quickly without worrying about typos. Use "Keep My Voice" for colleagues you know well, or "More Professional" for external stakeholders.</p>

        <h3>Social Media Posts</h3>
        <p>Perfect your posts before publishing. The keyboard shortcut works in Twitter, LinkedIn, Facebook, Reddit, and more.</p>

        <h3>Code Comments & Documentation</h3>
        <p>Write better documentation and commit messages. TypeMagic works on GitHub, GitLab, Stack Overflow, and other developer platforms.</p>

        <h3>Customer Support</h3>
        <p>Respond to customers with clear, error-free messages. Use "More Professional" to maintain brand voice.</p>

        <h3>Content Creation</h3>
        <p>Draft blog posts, articles, and long-form content with confidence. Use the bulletize feature to organize ideas.</p>

        <h3>Quick Notes & Messages</h3>
        <p>Clean up stream-of-consciousness writing in Slack, Discord, or messaging apps.</p>
      </div>

      <!-- Workflow Comparison -->
      <div class="section">
        <h2>Choosing Your Workflow</h2>
        <table class="comparison-table">
          <thead>
            <tr>
              <th>Workflow</th>
              <th>Best For</th>
              <th>Tone Options</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td><strong>Keyboard Shortcut</strong><br><span class="shortcut-key">Cmd+Option+T</span> (Mac)<br><span class="shortcut-key">Ctrl+Alt+T</span> (Windows/Linux)</td>
              <td>Quick corrections anywhere, maximum speed and convenience</td>
              <td>Keep My Voice (default)</td>
            </tr>
            <tr>
              <td><strong>Popup Interface</strong><br>(Click extension icon)</td>
              <td>Google Docs, choosing specific tones, quick actions (Bulletize, Summarize)</td>
              <td>All three tones + Quick Actions</td>
            </tr>
          </tbody>
        </table>
      </div>

      <!-- Google Docs Workflow -->
      <div class="section">
        <h2>Google Docs Workflow</h2>
        <p>Due to browser security restrictions, Google Docs requires a copy-paste workflow:</p>

        <div class="workflow">
          <div class="workflow-step">
            <div class="step-number">1</div>
            <div class="step-content">
              <strong>Select and copy</strong> your text in Google Docs (<span class="shortcut-key">Cmd+C</span> or <span class="shortcut-key">Ctrl+C</span>)
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">2</div>
            <div class="step-content">
              <strong>Click the TypeMagic icon</strong> in your Chrome toolbar
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">3</div>
            <div class="step-content">
              <strong>Paste</strong> into the textarea at the top of the popup
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">4</div>
            <div class="step-content">
              <strong>Select your tone</strong> and click "Correct Text"
            </div>
          </div>
          <div class="workflow-step">
            <div class="step-number">5</div>
            <div class="step-content">
              <strong>Paste back</strong> into Google Docs (<span class="shortcut-key">Cmd+V</span> or <span class="shortcut-key">Ctrl+V</span>)
            </div>
          </div>
        </div>
      </div>

      <!-- Tips for Best Results -->
      <div class="section">
        <h2>Tips for Best Results</h2>
        <ul>
          <li><strong>Text Length:</strong> TypeMagic works best with at least a few sentences. Very short text (1-2 words) may not benefit from AI correction.</li>
          <li><strong>Paragraph Structure:</strong> TypeMagic automatically preserves and improves paragraph structure. Write freely, even in one long paragraph, and let TypeMagic organize it.</li>
          <li><strong>Review Output:</strong> AI corrections are usually excellent but not always perfect. Always review before sending important communications.</li>
          <li><strong>Partial Corrections:</strong> Select only the text you want to correct before using the keyboard shortcut. Great for fixing specific sections.</li>
          <li><strong>Use Markdown:</strong> Enable "Use Markdown Formatting" in settings for enhanced formatting with headers, bold, italic, and lists.</li>
          <li><strong>Custom Prompts:</strong> Advanced users can create custom system prompts in settings to control exactly how TypeMagic corrects text.</li>
        </ul>
      </div>

      <!-- Privacy & Performance -->
      <div class="section">
        <h2>Privacy & Performance</h2>

        <h3>Privacy First</h3>
        <p>TypeMagic is designed with privacy in mind:</p>
        <ul>
          <li>API keys are stored locally on your machine</li>
          <li>No tracking, analytics, or data collection</li>
          <li>Text is only sent to your chosen AI provider</li>
          <li>Use Ollama or the FastAPI integration for 100% local/internal processing with complete privacy</li>
        </ul>

        <h3>Performance Tips</h3>
        <ul>
          <li>For fastest results, use <code>gpt-4o-mini</code> (OpenAI) or <code>llama3.2</code> (Ollama)</li>
          <li>Larger models provide better quality but take longer</li>
          <li>Very long texts (5000+ words) may take 10-15 seconds</li>
          <li>Check your AI provider's rate limits if corrections slow down</li>
        </ul>
      </div>

      <!-- Troubleshooting -->
      <div class="section">
        <h2>Troubleshooting</h2>

        <h3>Keyboard Shortcut Not Working</h3>
        <ul>
          <li>Make sure you're clicking in a text field first</li>
          <li>Reload the page after installing or updating the extension</li>
          <li>Check that you're pressing the correct combination: <span class="shortcut-key">Cmd+Option+T</span> on Mac or <span class="shortcut-key">Ctrl+Alt+T</span> on Windows/Linux</li>
        </ul>

        <h3>Paragraphs Disappearing</h3>
        <ul>
          <li>This should be fixed in v1.1.0+. Make sure you're on the latest version.</li>
          <li>If using rich text editors with custom contentEditable fields, the extension now properly converts newlines to HTML breaks</li>
        </ul>

        <h3>Corrections Not Applying</h3>
        <ul>
          <li>Test your connection using the "Test Connection" button in the popup</li>
          <li>Verify your API key is correct in settings</li>
          <li>Check your AI provider's dashboard for rate limits or billing issues</li>
          <li>For Ollama: Ensure Ollama is running with <code>ollama serve</code></li>
        </ul>

        <h3>Tone Not Working as Expected</h3>
        <ul>
          <li>"Keep My Voice" should fix errors while maintaining your style</li>
          <li>"More Professional" will change casual language to formal</li>
          <li>"More Casual" will make formal text more conversational</li>
          <li>Try using the "Custom System Prompt" feature for fine-tuned control</li>
        </ul>
      </div>

      <!-- Advanced Features -->
      <div class="section">
        <h2>Advanced Features</h2>

        <h3>Custom System Prompts</h3>
        <p>Power users can create custom instructions for the AI in the settings page. Examples:</p>
        <ul>
          <li>"Only fix spelling, leave grammar unchanged"</li>
          <li>"Use British English spelling"</li>
          <li>"Add technical terminology for software development"</li>
          <li>"Write in the style of [specific author or publication]"</li>
        </ul>

        <h3>Multiple AI Providers</h3>
        <p>TypeMagic supports multiple AI providers for flexibility:</p>
        <ul>
          <li><strong>OpenAI:</strong> Best quality, fast, reliable (recommended)</li>
          <li><strong>Google Gemini:</strong> Generous free tier</li>
          <li><strong>Anthropic Claude:</strong> Excellent for nuanced corrections</li>
          <li><strong>Ollama:</strong> 100% local, free, private</li>
          <li><strong>Custom FastAPI:</strong> For self-hosted solutions</li>
        </ul>

        <h3>Markdown Formatting</h3>
        <p>Enable this in settings to have TypeMagic format your text with Markdown syntax, perfect for platforms that support it (GitHub, Notion, Slack, etc.)</p>
      </div>
    </div>

    <div class="footer">
      <p><strong>TypeMagic v1.3.0</strong></p>
      <p>Developed by Christopher Bradford</p>
      <p>For support, visit the GitHub repository or contact support@typemagic.pro </p>
    </div>
  </div>
</body>
</html>