@knowcode/doc-builder 1.5.11 → 1.5.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.118Z",
65
- "dateModified": "2025-07-22T08:32:13.118Z",
65
+ "datePublished": "2025-07-22T11:03:54.332Z",
66
+ "dateModified": "2025-07-22T11:03:54.332Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
@@ -101,7 +102,7 @@
101
102
 
102
103
  <div class="header-actions">
103
104
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
105
106
  </div>
106
107
 
107
108
 
@@ -152,8 +153,8 @@
152
153
  <div class="nav-content" >
153
154
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
154
155
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
155
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
156
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
156
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
157
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
157
158
  <div class="nav-section" data-level="1">
158
159
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
159
160
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -174,7 +175,7 @@
174
175
  <main class="content">
175
176
  <div class="content-inner">
176
177
  <h1>Document Standards for @knowcode/doc-builder</h1>
177
- <p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
178
+ <p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
178
179
  <h2>Overview</h2>
179
180
  <p>This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project should follow these guidelines to ensure consistency, clarity, and maintainability.</p>
180
181
  <h2>Document Structure Standards</h2>
@@ -184,7 +185,7 @@
184
185
 
185
186
  **Generated**: YYYY-MM-DD HH:MM UTC
186
187
  **Status**: Draft/In Progress/Complete
187
- **Verified**: (for verified information) / (for speculated information)
188
+ **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i> (for verified information) / <i class="ph ph-question" aria-label="question"></i> (for speculated information)
188
189
 
189
190
  ## Overview
190
191
 
@@ -243,16 +244,16 @@ Brief description of the document&#39;s contents and purpose.
243
244
  <h3>2. Information Verification</h3>
244
245
  <p>Mark all information with verification status:</p>
245
246
  <ul>
246
- <li>✅ <strong>Verified</strong>: Information confirmed through testing or official sources</li>
247
- <li>❓ <strong>Speculated</strong>: Assumptions or unconfirmed information</li>
248
- <li>⚠️ <strong>Warning</strong>: Important caveats or potential issues</li>
247
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Verified</strong>: Information confirmed through testing or official sources</li>
248
+ <li><i class="ph ph-question" aria-label="question"></i> <strong>Speculated</strong>: Assumptions or unconfirmed information</li>
249
+ <li><i class="ph ph-warning-circle" aria-label="warning"></i> <strong>Warning</strong>: Important caveats or potential issues</li>
249
250
  <li>🚧 <strong>In Progress</strong>: Features or documentation under development</li>
250
251
  </ul>
251
252
  <p>Example:</p>
252
253
  <pre><code class="language-markdown">### Feature Status
253
- - **Markdown parsing**: Fully implemented and tested
254
- - **Performance impact**: Estimated 100ms for 50 files
255
- - ⚠️ **Large files**: May timeout on files &gt; 10MB
254
+ - <i class="ph ph-check-circle" aria-label="checked"></i> **Markdown parsing**: Fully implemented and tested
255
+ - <i class="ph ph-question" aria-label="question"></i> **Performance impact**: Estimated 100ms for 50 files
256
+ - <i class="ph ph-warning-circle" aria-label="warning"></i> **Large files**: May timeout on files &gt; 10MB
256
257
  - 🚧 **Search feature**: Currently in development
257
258
  </code></pre>
258
259
  <h3>3. Code Examples</h3>
@@ -268,9 +269,9 @@ const config = {
268
269
 
269
270
  try {
270
271
  await build(config);
271
- console.log(&#39;✅ Build successful&#39;);
272
+ console.log(&#39;<i class="ph ph-check-circle" aria-label="checked"></i> Build successful&#39;);
272
273
  } catch (error) {
273
- console.error(&#39;❌ Build failed:&#39;, error.message);
274
+ console.error(&#39;<i class="ph ph-x-circle" aria-label="error"></i> Build failed:&#39;, error.message);
274
275
  }
275
276
  </code></pre>
276
277
  <p>Guidelines:</p>
@@ -360,9 +361,9 @@ npx doc-builder deploy --prod
360
361
  <p>Keep tables readable and well-formatted:</p>
361
362
  <pre><code class="language-markdown">| Feature | Status | Version | Notes |
362
363
  |---------|--------|---------|-------|
363
- | Mermaid | Ready | 1.0.0 | Full support |
364
+ | Mermaid | <i class="ph ph-check-circle" aria-label="checked"></i> Ready | 1.0.0 | Full support |
364
365
  | Search | 🚧 WIP | 1.5.0 | In development |
365
- | Auth | Ready | 1.3.0 | Optional feature |
366
+ | Auth | <i class="ph ph-check-circle" aria-label="checked"></i> Ready | 1.3.0 | Optional feature |
366
367
  </code></pre>
367
368
  <h3>Links</h3>
368
369
  <ul>
@@ -407,7 +408,7 @@ npx doc-builder deploy --prod
407
408
 
408
409
  **Generated**: [date]
409
410
  **Status**: Complete
410
- **Verified**:
411
+ **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i>
411
412
 
412
413
  ## Overview
413
414
  What the feature does and why it exists
@@ -430,7 +431,7 @@ Common issues and solutions
430
431
 
431
432
  **Generated**: [date]
432
433
  **Status**: Complete
433
- **Verified**:
434
+ **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i>
434
435
 
435
436
  ## Overview
436
437
  Technical context and goals
@@ -453,7 +454,7 @@ Benchmarks and optimization
453
454
 
454
455
  **Generated**: [date]
455
456
  **Status**: Complete
456
- **Verified**:
457
+ **Verified**: <i class="ph ph-check-circle" aria-label="checked"></i>
457
458
 
458
459
  ## Overview
459
460
  What the API does
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.126Z",
65
- "dateModified": "2025-07-22T08:32:13.126Z",
65
+ "datePublished": "2025-07-22T11:03:54.338Z",
66
+ "dateModified": "2025-07-22T11:03:54.338Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html"
@@ -101,7 +102,7 @@
101
102
 
102
103
  <div class="header-actions">
103
104
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
105
106
  </div>
106
107
 
107
108
 
@@ -152,8 +153,8 @@
152
153
  <div class="nav-content" >
153
154
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
154
155
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
155
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
156
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
156
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
157
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
157
158
  <div class="nav-section" data-level="1">
158
159
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
159
160
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.130Z",
65
- "dateModified": "2025-07-22T08:32:13.130Z",
65
+ "datePublished": "2025-07-22T11:03:54.341Z",
66
+ "dateModified": "2025-07-22T11:03:54.341Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
@@ -101,7 +102,7 @@
101
102
 
102
103
  <div class="header-actions">
103
104
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
105
106
  </div>
106
107
 
107
108
 
@@ -152,8 +153,8 @@
152
153
  <div class="nav-content" >
153
154
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
154
155
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
155
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
156
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
156
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
157
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
157
158
  <div class="nav-section" data-level="1">
158
159
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
159
160
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -412,10 +413,10 @@ author: Different Author
412
413
  <pre><code class="language-bash">npx @knowcode/doc-builder build
413
414
  </code></pre>
414
415
  <p>You&#39;ll see SEO generation in the output:</p>
415
- <pre><code>🗺️ Generating sitemap.xml...
416
- Generated sitemap.xml with 23 URLs
417
- 🤖 Generating robots.txt...
418
- Generated robots.txt
416
+ <pre><code><i class="ph ph-map-trifold" aria-label="map"></i> Generating sitemap.xml...
417
+ <i class="ph ph-check-circle" aria-label="checked"></i> Generated sitemap.xml with 23 URLs
418
+ <i class="ph ph-robot" aria-label="automation"></i> Generating robots.txt...
419
+ <i class="ph ph-check-circle" aria-label="checked"></i> Generated robots.txt
419
420
  </code></pre>
420
421
  <h3>2. Check Generated Files</h3>
421
422
  <ul>
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.137Z",
65
- "dateModified": "2025-07-22T08:32:13.137Z",
65
+ "datePublished": "2025-07-22T11:03:54.346Z",
66
+ "dateModified": "2025-07-22T11:03:54.346Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
@@ -101,7 +102,7 @@
101
102
 
102
103
  <div class="header-actions">
103
104
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
105
106
  </div>
106
107
 
107
108
 
@@ -152,8 +153,8 @@
152
153
  <div class="nav-content" >
153
154
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
154
155
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
155
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
156
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
156
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
157
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
157
158
  <div class="nav-section" data-level="1">
158
159
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
159
160
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -174,7 +175,7 @@
174
175
  <main class="content">
175
176
  <div class="content-inner">
176
177
  <h1>SEO Optimization Guide</h1>
177
- <p><strong>Generated</strong>: 2025-07-22 09:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
178
+ <p><strong>Generated</strong>: 2025-07-22 09:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
178
179
  <h2>Overview</h2>
179
180
  <p>@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search engines. This guide explains what these features do, how to use them effectively, and provides references to authoritative SEO resources.</p>
180
181
  <h2>Why SEO Matters for Documentation</h2>
@@ -308,15 +309,15 @@ keywords: [&quot;authentication&quot;, &quot;security&quot;, &quot;password prot
308
309
  <h3>Examples</h3>
309
310
  <p>Good titles:</p>
310
311
  <ul>
311
- <li>✅ &quot;Authentication Guide | Doc Builder&quot; (38 chars)</li>
312
- <li>✅ &quot;SEO Best Practices for Documentation | MyDocs&quot; (45 chars)</li>
313
- <li>✅ &quot;Quick Start: Deploy to Vercel | Doc Builder&quot; (43 chars)</li>
312
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> &quot;Authentication Guide | Doc Builder&quot; (38 chars)</li>
313
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> &quot;SEO Best Practices for Documentation | MyDocs&quot; (45 chars)</li>
314
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> &quot;Quick Start: Deploy to Vercel | Doc Builder&quot; (43 chars)</li>
314
315
  </ul>
315
316
  <p>Bad titles:</p>
316
317
  <ul>
317
- <li>❌ &quot;Guide&quot; (5 chars - too short)</li>
318
- <li>❌ &quot;The Complete Comprehensive Guide to Setting Up Authentication and Security for Your Documentation Website | Doc Builder&quot; (118 chars - too long)</li>
319
- <li>❌ &quot;Page Title | Site Name | Category | Subcategory&quot; (keyword stuffing)</li>
318
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;Guide&quot; (5 chars - too short)</li>
319
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;The Complete Comprehensive Guide to Setting Up Authentication and Security for Your Documentation Website | Doc Builder&quot; (118 chars - too long)</li>
320
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;Page Title | Site Name | Category | Subcategory&quot; (keyword stuffing)</li>
320
321
  </ul>
321
322
  <h2>Meta Descriptions</h2>
322
323
  <h3>Best Practices</h3>
@@ -338,13 +339,13 @@ keywords: [&quot;authentication&quot;, &quot;security&quot;, &quot;password prot
338
339
  <h3>Examples</h3>
339
340
  <p>Good descriptions:</p>
340
341
  <ul>
341
- <li>✅ &quot;Learn how to implement authentication in your documentation site. Step-by-step guide with code examples and security best practices.&quot; (139 chars)</li>
342
- <li>✅ &quot;Optimize your documentation for search engines with our comprehensive SEO guide. Covers titles, descriptions, and keyword strategies.&quot; (143 chars)</li>
342
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> &quot;Learn how to implement authentication in your documentation site. Step-by-step guide with code examples and security best practices.&quot; (139 chars)</li>
343
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> &quot;Optimize your documentation for search engines with our comprehensive SEO guide. Covers titles, descriptions, and keyword strategies.&quot; (143 chars)</li>
343
344
  </ul>
344
345
  <p>Bad descriptions:</p>
345
346
  <ul>
346
- <li>❌ &quot;This page is about authentication.&quot; (35 chars - too short)</li>
347
- <li>❌ &quot;Authentication authentication authentication...&quot; (keyword stuffing)</li>
347
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;This page is about authentication.&quot; (35 chars - too short)</li>
348
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;Authentication authentication authentication...&quot; (keyword stuffing)</li>
348
349
  </ul>
349
350
  <h2>Keywords Strategy</h2>
350
351
  <h3>Modern Keyword Approach (2025)</h3>
@@ -388,23 +389,23 @@ doc-builder seo-check html/guide.html
388
389
  <h3>What It Analyzes in HTML</h3>
389
390
  <p>The command inspects the actual HTML output that search engines see:</p>
390
391
  <ul>
391
- <li>✅ <strong>Title tags</strong> - Presence and optimal length (50-60 chars)</li>
392
- <li>✅ <strong>Meta descriptions</strong> - Quality and character count (140-160)</li>
393
- <li>✅ <strong>Keywords meta tag</strong> - Presence of relevant keywords</li>
394
- <li>✅ <strong>Canonical URLs</strong> - Prevents duplicate content penalties</li>
395
- <li>✅ <strong>H1 tags</strong> - Ensures proper heading structure</li>
396
- <li>✅ <strong>Open Graph tags</strong> - Social media optimization</li>
397
- <li>✅ <strong>Twitter Card tags</strong> - Twitter/X optimization</li>
398
- <li>✅ <strong>Structured data</strong> - JSON-LD implementation</li>
392
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Title tags</strong> - Presence and optimal length (50-60 chars)</li>
393
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Meta descriptions</strong> - Quality and character count (140-160)</li>
394
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Keywords meta tag</strong> - Presence of relevant keywords</li>
395
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Canonical URLs</strong> - Prevents duplicate content penalties</li>
396
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>H1 tags</strong> - Ensures proper heading structure</li>
397
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Open Graph tags</strong> - Social media optimization</li>
398
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Twitter Card tags</strong> - Twitter/X optimization</li>
399
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Structured data</strong> - JSON-LD implementation</li>
399
400
  </ul>
400
401
  <h3>Example Output</h3>
401
- <pre><code>🔍 Analyzing SEO in generated HTML files...
402
+ <pre><code><i class="ph ph-magnifying-glass" aria-label="search"></i> Analyzing SEO in generated HTML files...
402
403
 
403
- 📊 SEO Analysis Complete
404
+ <i class="ph ph-chart-bar" aria-label="chart"></i> SEO Analysis Complete
404
405
 
405
406
  Analyzed 14 files
406
407
 
407
- Found 2 issues:
408
+ <i class="ph ph-x-circle" aria-label="error"></i> Found 2 issues:
408
409
 
409
410
  guides/api.html:
410
411
  Title too long (75 chars, max 60)
@@ -413,7 +414,7 @@ Analyzed 14 files
413
414
  setup.html:
414
415
  Missing meta description
415
416
 
416
- 💡 8 suggestions:
417
+ <i class="ph ph-lightbulb" aria-label="idea"></i> 8 suggestions:
417
418
 
418
419
  index.html: Description too short (95 chars, ideal 140-160)
419
420
  guides/auth.html: No keywords meta tag found
@@ -478,28 +479,28 @@ Your content here...
478
479
  <h2>Common SEO Mistakes to Avoid</h2>
479
480
  <h3>1. Duplicate Content</h3>
480
481
  <ul>
481
- <li>❌ Same description on multiple pages</li>
482
- <li>✅ Unique descriptions for each page</li>
482
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Same description on multiple pages</li>
483
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Unique descriptions for each page</li>
483
484
  </ul>
484
485
  <h3>2. Keyword Stuffing</h3>
485
486
  <ul>
486
- <li>❌ &quot;Guide guide documentation guide tutorial guide&quot;</li>
487
- <li>✅ Natural keyword usage in context</li>
487
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;Guide guide documentation guide tutorial guide&quot;</li>
488
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Natural keyword usage in context</li>
488
489
  </ul>
489
490
  <h3>3. Ignoring Mobile</h3>
490
491
  <ul>
491
- <li>❌ Long titles that get cut off on mobile</li>
492
- <li>✅ Test how titles appear on different devices</li>
492
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Long titles that get cut off on mobile</li>
493
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Test how titles appear on different devices</li>
493
494
  </ul>
494
495
  <h3>4. Missing Descriptions</h3>
495
496
  <ul>
496
- <li>❌ Leaving description blank</li>
497
- <li>✅ Always provide meaningful descriptions</li>
497
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Leaving description blank</li>
498
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Always provide meaningful descriptions</li>
498
499
  </ul>
499
500
  <h3>5. Generic Titles</h3>
500
501
  <ul>
501
- <li>❌ &quot;Documentation&quot;, &quot;Guide&quot;, &quot;Page 1&quot;</li>
502
- <li>✅ Specific, descriptive titles</li>
502
+ <li><i class="ph ph-x-circle" aria-label="error"></i> &quot;Documentation&quot;, &quot;Guide&quot;, &quot;Page 1&quot;</li>
503
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Specific, descriptive titles</li>
503
504
  </ul>
504
505
  <h2>SEO Checklist</h2>
505
506
  <p>Before publishing, ensure:</p>
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.141Z",
65
- "dateModified": "2025-07-22T08:32:13.141Z",
65
+ "datePublished": "2025-07-22T11:03:54.350Z",
66
+ "dateModified": "2025-07-22T11:03:54.350Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
@@ -101,7 +102,7 @@
101
102
 
102
103
  <div class="header-actions">
103
104
  <div class="deployment-info">
104
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
105
106
  </div>
106
107
 
107
108
 
@@ -152,8 +153,8 @@
152
153
  <div class="nav-content" >
153
154
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
154
155
  <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
155
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
156
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
156
+ <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
157
+ <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
157
158
  <div class="nav-section" data-level="1">
158
159
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
159
160
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -174,7 +175,7 @@
174
175
  <main class="content">
175
176
  <div class="content-inner">
176
177
  <h1>Troubleshooting Guide for @knowcode/doc-builder</h1>
177
- <p><strong>Generated</strong>: 2025-07-21 19:15 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
178
+ <p><strong>Generated</strong>: 2025-07-21 19:15 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
178
179
  <h2>Overview</h2>
179
180
  <p>This guide helps you resolve common issues when using @knowcode/doc-builder. Most problems have simple solutions, and this guide covers the most frequent ones.</p>
180
181
  <h2>NPX Cache Issues</h2>
@@ -182,10 +183,10 @@
182
183
  <p>The most common issue users face is npx caching an older version of doc-builder.</p>
183
184
  <p><strong>Symptoms:</strong></p>
184
185
  <ul>
185
- <li>❌ Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
186
- <li>❌ New features aren&#39;t available despite updating</li>
187
- <li>❌ Bug fixes don&#39;t appear to be working</li>
188
- <li>❌ Version shown doesn&#39;t match npm registry</li>
186
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
187
+ <li><i class="ph ph-x-circle" aria-label="error"></i> New features aren&#39;t available despite updating</li>
188
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Bug fixes don&#39;t appear to be working</li>
189
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Version shown doesn&#39;t match npm registry</li>
189
190
  </ul>
190
191
  <p><strong>Example:</strong></p>
191
192
  <pre><code class="language-bash">$ npx @knowcode/doc-builder --version
@@ -249,10 +250,10 @@ npx doc-builder deploy # Uses local version
249
250
  </li>
250
251
  <li><p><strong>Ensure correct file extensions:</strong></p>
251
252
  <ul>
252
- <li>✅ <code>README.md</code></li>
253
- <li>✅ <code>guide.md</code></li>
254
- <li>❌ <code>README.txt</code></li>
255
- <li>❌ <code>guide.markdown</code></li>
253
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
254
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
255
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
256
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
256
257
  </ul>
257
258
  </li>
258
259
  <li><p><strong>Use custom input directory:</strong></p>
@@ -285,13 +286,16 @@ npm install -g vercel
285
286
 
286
287
  # Verify installation
287
288
  vercel --version
289
+
290
+ # Then retry deployment
291
+ npx @knowcode/doc-builder deploy
288
292
  </code></pre>
289
293
  <h3>Deployment Fails</h3>
290
294
  <p><strong>Common causes:</strong></p>
291
295
  <ol>
292
- <li><p><strong>Root Directory Issue</strong></p>
293
- <pre><code class="language-bash"># Reset Vercel configuration
294
- npx @knowcode/doc-builder reset-vercel
296
+ <li><p><strong>Not Logged Into Vercel</strong></p>
297
+ <pre><code class="language-bash"># Login to Vercel first
298
+ vercel login
295
299
  </code></pre>
296
300
  </li>
297
301
  <li><p><strong>Build Not Complete</strong></p>
@@ -300,21 +304,24 @@ npx @knowcode/doc-builder build
300
304
  npx @knowcode/doc-builder deploy
301
305
  </code></pre>
302
306
  </li>
303
- <li><p><strong>Wrong Directory</strong></p>
307
+ <li><p><strong>Project Name Already Taken</strong></p>
304
308
  <ul>
305
- <li>Ensure you&#39;re in project root</li>
306
- <li>Check that <code>html/</code> directory exists</li>
309
+ <li>Choose a different project name</li>
310
+ <li>Or delete the existing project in Vercel dashboard</li>
307
311
  </ul>
308
312
  </li>
309
313
  </ol>
310
314
  <h3>Wrong Production URL Displayed</h3>
311
- <p><strong>Problem:</strong> Deployment shows incorrect URL (e.g., <code>doc.vercel.app</code> instead of <code>doc-builder-delta.vercel.app</code>)</p>
312
- <p><strong>Fixed in:</strong> v1.4.22+</p>
313
- <p><strong>Solution:</strong></p>
314
- <pre><code class="language-bash"># Update to latest version
315
+ <p><strong>Problem:</strong> Deployment shows incorrect URL</p>
316
+ <p><strong>Solution 1:</strong> Update to latest version</p>
317
+ <pre><code class="language-bash"># Clear cache and update
315
318
  npx clear-npx-cache
316
319
  npx @knowcode/doc-builder@latest deploy
317
320
  </code></pre>
321
+ <p><strong>Solution 2:</strong> Set custom URL</p>
322
+ <pre><code class="language-bash"># Set your actual production URL
323
+ npx @knowcode/doc-builder set-production-url https://my-docs.vercel.app
324
+ </code></pre>
318
325
  <h2>Configuration Issues</h2>
319
326
  <h3>Config File Not Loading</h3>
320
327
  <p><strong>Symptoms:</strong></p>
@@ -326,9 +333,9 @@ npx @knowcode/doc-builder@latest deploy
326
333
  <ol>
327
334
  <li><p><strong>Check file name:</strong></p>
328
335
  <ul>
329
- <li>✅ <code>doc-builder.config.js</code></li>
330
- <li>❌ <code>docbuilder.config.js</code></li>
331
- <li>❌ <code>doc-builder-config.js</code></li>
336
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
337
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
338
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
332
339
  </ul>
333
340
  </li>
334
341
  <li><p><strong>Verify export format:</strong></p>
@@ -476,7 +483,7 @@ npm --version
476
483
  </tr>
477
484
  <tr>
478
485
  <td>Vercel deploy fails</td>
479
- <td><code>npx @knowcode/doc-builder reset-vercel</code></td>
486
+ <td><code>vercel login</code> then retry</td>
480
487
  </tr>
481
488
  <tr>
482
489
  <td>No markdown found</td>
@@ -494,6 +501,10 @@ npm --version
494
501
  <td>Config not loading</td>
495
502
  <td>Check filename and format</td>
496
503
  </tr>
504
+ <tr>
505
+ <td>404 after deploy</td>
506
+ <td>Check Deployment Protection settings</td>
507
+ </tr>
497
508
  </tbody></table>
498
509
  <hr>
499
510
  <h2>Document History</h2>