@knowcode/doc-builder 1.5.16 → 1.5.18

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.
@@ -62,8 +62,8 @@
62
62
  "name": "Knowcode Ltd",
63
63
  "url": "https://knowcode.tech"
64
64
  },
65
- "datePublished": "2025-07-22T11:52:26.153Z",
66
- "dateModified": "2025-07-22T11:52:26.153Z",
65
+ "datePublished": "2025-07-22T15:51:37.139Z",
66
+ "dateModified": "2025-07-22T15:51:37.139Z",
67
67
  "mainEntityOfPage": {
68
68
  "@type": "WebPage",
69
69
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
@@ -102,7 +102,7 @@
102
102
 
103
103
  <div class="header-actions">
104
104
  <div class="deployment-info">
105
- <span class="deployment-date" title="Built with doc-builder v1.5.15">Last updated: Jul 22, 2025, 11:52 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.17">Last updated: Jul 22, 2025, 03:51 PM UTC</span>
106
106
  </div>
107
107
 
108
108
 
@@ -167,7 +167,8 @@
167
167
  <a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
168
168
  <a href="/guides/seo-guide.html" class="nav-item active" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
169
169
  <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
170
- <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
170
+ <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
171
+ <a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
171
172
  </nav>
172
173
  <div class="resize-handle"></div>
173
174
  </aside>
@@ -181,7 +182,7 @@
181
182
  <p>@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and look great when shared on social media. This guide covers all SEO features and how to configure them.</p>
182
183
  <h2>Quick Start</h2>
183
184
  <p>Run the SEO setup wizard to configure all SEO settings interactively:</p>
184
- <pre><code class="language-bash">npx @knowcode/doc-builder setup-seo
185
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest setup-seo
185
186
  </code></pre>
186
187
  <h2>SEO Features</h2>
187
188
  <h3>1. Meta Tags</h3>
@@ -248,7 +249,7 @@
248
249
  <h2>Configuration</h2>
249
250
  <h3>Using the Setup Wizard</h3>
250
251
  <p>The easiest way to configure SEO is using the interactive wizard:</p>
251
- <pre><code class="language-bash">npx @knowcode/doc-builder setup-seo
252
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest setup-seo
252
253
  </code></pre>
253
254
  <p>You&#39;ll be prompted for:</p>
254
255
  <ol>
@@ -411,7 +412,7 @@ author: Different Author
411
412
  </code></pre>
412
413
  <h2>Verification</h2>
413
414
  <h3>1. Build with SEO</h3>
414
- <pre><code class="language-bash">npx @knowcode/doc-builder build
415
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest build
415
416
  </code></pre>
416
417
  <p>You&#39;ll see SEO generation in the output:</p>
417
418
  <pre><code><i class="ph ph-map-trifold" aria-label="map"></i> Generating sitemap.xml...
@@ -551,7 +552,7 @@ author: Different Author
551
552
  <li>Be properly indexed by search engines</li>
552
553
  <li>Provide rich previews on social media</li>
553
554
  </ul>
554
- <p>Run <code>npx @knowcode/doc-builder setup-seo</code> to get started!</p>
555
+ <p>Run <code>npx @knowcode/doc-builder@latest setup-seo</code> to get started!</p>
555
556
 
556
557
  </div>
557
558
  </main>
@@ -62,8 +62,8 @@
62
62
  "name": "Knowcode Ltd",
63
63
  "url": "https://knowcode.tech"
64
64
  },
65
- "datePublished": "2025-07-22T11:52:26.160Z",
66
- "dateModified": "2025-07-22T11:52:26.160Z",
65
+ "datePublished": "2025-07-22T15:51:37.146Z",
66
+ "dateModified": "2025-07-22T15:51:37.146Z",
67
67
  "mainEntityOfPage": {
68
68
  "@type": "WebPage",
69
69
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
@@ -102,7 +102,7 @@
102
102
 
103
103
  <div class="header-actions">
104
104
  <div class="deployment-info">
105
- <span class="deployment-date" title="Built with doc-builder v1.5.15">Last updated: Jul 22, 2025, 11:52 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.17">Last updated: Jul 22, 2025, 03:51 PM UTC</span>
106
106
  </div>
107
107
 
108
108
 
@@ -167,7 +167,8 @@
167
167
  <a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
168
168
  <a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
169
169
  <a href="/guides/seo-optimization-guide.html" class="nav-item active" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
170
- <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
170
+ <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
171
+ <a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
171
172
  </nav>
172
173
  <div class="resize-handle"></div>
173
174
  </aside>
@@ -62,8 +62,8 @@
62
62
  "name": "Knowcode Ltd",
63
63
  "url": "https://knowcode.tech"
64
64
  },
65
- "datePublished": "2025-07-22T11:52:26.163Z",
66
- "dateModified": "2025-07-22T11:52:26.163Z",
65
+ "datePublished": "2025-07-22T15:51:37.149Z",
66
+ "dateModified": "2025-07-22T15:51:37.149Z",
67
67
  "mainEntityOfPage": {
68
68
  "@type": "WebPage",
69
69
  "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
@@ -102,7 +102,7 @@
102
102
 
103
103
  <div class="header-actions">
104
104
  <div class="deployment-info">
105
- <span class="deployment-date" title="Built with doc-builder v1.5.15">Last updated: Jul 22, 2025, 11:52 AM UTC</span>
105
+ <span class="deployment-date" title="Built with doc-builder v1.5.17">Last updated: Jul 22, 2025, 03:51 PM UTC</span>
106
106
  </div>
107
107
 
108
108
 
@@ -167,7 +167,8 @@
167
167
  <a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="fas fa-file-alt"></i> Phosphor Icons Guide</a>
168
168
  <a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="fas fa-file-alt"></i> Seo Guide</a>
169
169
  <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
170
- <a href="/guides/troubleshooting-guide.html" class="nav-item active" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a></div></div>
170
+ <a href="/guides/troubleshooting-guide.html" class="nav-item active" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
171
+ <a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
171
172
  </nav>
172
173
  <div class="resize-handle"></div>
173
174
  </aside>
@@ -190,7 +191,7 @@
190
191
  <li><i class="ph ph-x-circle" aria-label="error"></i> Version shown doesn&#39;t match npm registry</li>
191
192
  </ul>
192
193
  <p><strong>Example:</strong></p>
193
- <pre><code class="language-bash">$ npx @knowcode/doc-builder --version
194
+ <pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
194
195
  1.4.11 # Old version!
195
196
 
196
197
  # But npm shows:
@@ -209,7 +210,6 @@ npx @knowcode/doc-builder@1.4.22
209
210
  </code></pre>
210
211
  <h3>Why This Happens</h3>
211
212
  <div class="mermaid-wrapper">
212
- <div class="mermaid-title">Diagram</div>
213
213
  <div class="mermaid">graph TD
214
214
  A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
215
215
  B -->|Yes| C[Use cached version]
@@ -258,7 +258,7 @@ npx doc-builder deploy # Uses local version
258
258
  </ul>
259
259
  </li>
260
260
  <li><p><strong>Use custom input directory:</strong></p>
261
- <pre><code class="language-bash">npx @knowcode/doc-builder build --input my-docs
261
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest build --input my-docs
262
262
  </code></pre>
263
263
  </li>
264
264
  </ol>
@@ -273,7 +273,7 @@ npx doc-builder deploy # Uses local version
273
273
  <p><strong>Solution:</strong></p>
274
274
  <pre><code class="language-bash"># Clean build
275
275
  rm -rf html/
276
- npx @knowcode/doc-builder build
276
+ npx @knowcode/doc-builder@latest build
277
277
 
278
278
  # Check output
279
279
  ls -la html/
@@ -289,7 +289,7 @@ npm install -g vercel
289
289
  vercel --version
290
290
 
291
291
  # Then retry deployment
292
- npx @knowcode/doc-builder deploy
292
+ npx @knowcode/doc-builder@latest deploy
293
293
  </code></pre>
294
294
  <h3>Deployment Fails</h3>
295
295
  <p><strong>Common causes:</strong></p>
@@ -301,8 +301,8 @@ vercel login
301
301
  </li>
302
302
  <li><p><strong>Build Not Complete</strong></p>
303
303
  <pre><code class="language-bash"># Build before deploy
304
- npx @knowcode/doc-builder build
305
- npx @knowcode/doc-builder deploy
304
+ npx @knowcode/doc-builder@latest build
305
+ npx @knowcode/doc-builder@latest deploy
306
306
  </code></pre>
307
307
  </li>
308
308
  <li><p><strong>Project Name Already Taken</strong></p>
@@ -321,7 +321,7 @@ npx @knowcode/doc-builder@latest deploy
321
321
  </code></pre>
322
322
  <p><strong>Solution 2:</strong> Set custom URL</p>
323
323
  <pre><code class="language-bash"># Set your actual production URL
324
- npx @knowcode/doc-builder set-production-url https://my-docs.vercel.app
324
+ npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
325
325
  </code></pre>
326
326
  <h2>Configuration Issues</h2>
327
327
  <h3>Config File Not Loading</h3>
@@ -352,7 +352,7 @@ export default {
352
352
  </code></pre>
353
353
  </li>
354
354
  <li><p><strong>Use explicit config path:</strong></p>
355
- <pre><code class="language-bash">npx @knowcode/doc-builder build --config ./my-config.js
355
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest build --config ./my-config.js
356
356
  </code></pre>
357
357
  </li>
358
358
  </ol>
@@ -402,7 +402,7 @@ module.exports = {
402
402
  <p><strong>Error:</strong> <code>Port 3000 is already in use</code></p>
403
403
  <p><strong>Solutions:</strong></p>
404
404
  <pre><code class="language-bash"># Use different port
405
- npx @knowcode/doc-builder dev --port 8080
405
+ npx @knowcode/doc-builder@latest dev --port 8080
406
406
 
407
407
  # Find process using port
408
408
  lsof -i :3000 # macOS/Linux
@@ -450,7 +450,7 @@ source ~/.zshrc
450
450
  <p>When reporting issues, include:</p>
451
451
  <ol>
452
452
  <li><p><strong>Version information:</strong></p>
453
- <pre><code class="language-bash">npx @knowcode/doc-builder --version
453
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest --version
454
454
  node --version
455
455
  npm --version
456
456
  </code></pre>