@knowcode/doc-builder 1.5.17 → 1.5.19
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.
- package/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +20 -0
- package/CLAUDE.md +3 -0
- package/assets/css/notion-style.css +13 -1
- package/html/README.html +3 -3
- package/html/css/notion-style.css +14 -0
- package/html/documentation-index.html +3 -3
- package/html/guides/authentication-guide.html +3 -3
- package/html/guides/claude-workflow-guide.html +375 -43
- package/html/guides/documentation-standards.html +3 -3
- package/html/guides/google-site-verification-guide.html +3 -3
- package/html/guides/phosphor-icons-guide.html +3 -3
- package/html/guides/seo-guide.html +3 -3
- package/html/guides/seo-optimization-guide.html +3 -3
- package/html/guides/troubleshooting-guide.html +3 -3
- package/html/guides/windows-setup-guide.html +130 -34
- package/html/index.html +3 -3
- package/html/sitemap.xml +17 -17
- package/html/vercel-cli-setup-guide.html +3 -3
- package/html/vercel-first-time-setup-guide.html +3 -3
- package/package.json +1 -1
- package/publish.sh +138 -20
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.132Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.132Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.148Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.148Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/google-site-verification-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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.156Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.156Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.165Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.165Z",
|
|
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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.176Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.176Z",
|
|
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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.179Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.179Z",
|
|
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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.184Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.184Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/windows-setup-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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -195,6 +195,33 @@
|
|
|
195
195
|
<li><i class="ph ph-check-circle" aria-label="checked"></i> PowerShell 5.1+ (included with Windows)</li>
|
|
196
196
|
<li><i class="ph ph-star" aria-label="star"></i> Visual Studio Code (recommended) - <a href="https://code.visualstudio.com">code.visualstudio.com</a></li>
|
|
197
197
|
</ul>
|
|
198
|
+
<h2>Understanding Claude vs Claude Code</h2>
|
|
199
|
+
<h3>What's the Difference?</h3>
|
|
200
|
+
<p><strong>Claude.ai</strong> (Web Interface):</p>
|
|
201
|
+
<ul>
|
|
202
|
+
<li>Browser-based chat interface</li>
|
|
203
|
+
<li>General-purpose AI assistant</li>
|
|
204
|
+
<li>Good for conversations and one-off tasks</li>
|
|
205
|
+
<li>Limited file handling capabilities</li>
|
|
206
|
+
</ul>
|
|
207
|
+
<p><strong>Claude Code</strong> (Command-Line Tool):</p>
|
|
208
|
+
<ul>
|
|
209
|
+
<li>Terminal/command-line interface</li>
|
|
210
|
+
<li>Specialized for software development</li>
|
|
211
|
+
<li>Direct file system access</li>
|
|
212
|
+
<li>Can read, write, and modify multiple files</li>
|
|
213
|
+
<li>Integrated with your development workflow</li>
|
|
214
|
+
<li>Requires Pro or Max subscription</li>
|
|
215
|
+
</ul>
|
|
216
|
+
<h3>Why Claude Code for Documentation?</h3>
|
|
217
|
+
<p>Claude Code excels at:</p>
|
|
218
|
+
<ul>
|
|
219
|
+
<li>Reading entire codebases</li>
|
|
220
|
+
<li>Generating multiple markdown files</li>
|
|
221
|
+
<li>Updating existing documentation</li>
|
|
222
|
+
<li>Creating consistent formatting</li>
|
|
223
|
+
<li>Working directly in your project folder</li>
|
|
224
|
+
</ul>
|
|
198
225
|
<h2>The Three-Part System</h2>
|
|
199
226
|
<p>Understanding the conceptual separation is crucial:</p>
|
|
200
227
|
<table>
|
|
@@ -231,21 +258,21 @@
|
|
|
231
258
|
<tbody><tr>
|
|
232
259
|
<td><strong>Claude</strong></td>
|
|
233
260
|
<td>AI content generation</td>
|
|
234
|
-
<td>Pro ($20/mo) or
|
|
261
|
+
<td>Pro ($20/mo) or Max ($200/mo) plan required</td>
|
|
235
262
|
<td><a href="https://claude.ai">claude.ai</a></td>
|
|
236
263
|
</tr>
|
|
237
264
|
<tr>
|
|
265
|
+
<td><strong>GitHub</strong></td>
|
|
266
|
+
<td>Version control</td>
|
|
267
|
+
<td>Free account (required for Vercel)</td>
|
|
268
|
+
<td><a href="https://github.com">github.com</a></td>
|
|
269
|
+
</tr>
|
|
270
|
+
<tr>
|
|
238
271
|
<td><strong>Vercel</strong></td>
|
|
239
272
|
<td>Free web hosting</td>
|
|
240
273
|
<td>Free Hobby account sufficient</td>
|
|
241
274
|
<td><a href="https://vercel.com">vercel.com</a></td>
|
|
242
275
|
</tr>
|
|
243
|
-
<tr>
|
|
244
|
-
<td><strong>GitHub</strong></td>
|
|
245
|
-
<td>Version control (optional)</td>
|
|
246
|
-
<td>Free account for Vercel integration</td>
|
|
247
|
-
<td><a href="https://github.com">github.com</a></td>
|
|
248
|
-
</tr>
|
|
249
276
|
</tbody></table>
|
|
250
277
|
<h3>Software Requirements</h3>
|
|
251
278
|
<table>
|
|
@@ -347,24 +374,26 @@
|
|
|
347
374
|
<strong>Claude Account</strong></p>
|
|
348
375
|
<ul>
|
|
349
376
|
<li><input disabled="" type="checkbox"> Sign up at <a href="https://claude.ai">claude.ai</a></li>
|
|
350
|
-
<li><input disabled="" type="checkbox"> Subscribe to Pro ($20/mo) or
|
|
377
|
+
<li><input disabled="" type="checkbox"> Subscribe to Pro ($20/mo) or Max ($200/mo) plan</li>
|
|
351
378
|
<li><input disabled="" type="checkbox"> Verify email</li>
|
|
379
|
+
<li><input disabled="" type="checkbox"> Note: Free plan does NOT include Claude Code access</li>
|
|
352
380
|
</ul>
|
|
353
381
|
</li>
|
|
354
382
|
<li><p><input disabled="" type="checkbox">
|
|
355
|
-
<strong>
|
|
383
|
+
<strong>GitHub Account</strong> (Required)</p>
|
|
356
384
|
<ul>
|
|
357
|
-
<li><input disabled="" type="checkbox"> Sign up at <a href="https://
|
|
358
|
-
<li><input disabled="" type="checkbox">
|
|
359
|
-
<li><input disabled="" type="checkbox">
|
|
385
|
+
<li><input disabled="" type="checkbox"> Sign up at <a href="https://github.com">github.com</a></li>
|
|
386
|
+
<li><input disabled="" type="checkbox"> Configure username and email</li>
|
|
387
|
+
<li><input disabled="" type="checkbox"> Enable 2FA (recommended)</li>
|
|
388
|
+
<li><input disabled="" type="checkbox"> Required for Vercel deployment</li>
|
|
360
389
|
</ul>
|
|
361
390
|
</li>
|
|
362
391
|
<li><p><input disabled="" type="checkbox">
|
|
363
|
-
<strong>
|
|
392
|
+
<strong>Vercel Account</strong></p>
|
|
364
393
|
<ul>
|
|
365
|
-
<li><input disabled="" type="checkbox"> Sign up at <a href="https://
|
|
366
|
-
<li><input disabled="" type="checkbox">
|
|
367
|
-
<li><input disabled="" type="checkbox">
|
|
394
|
+
<li><input disabled="" type="checkbox"> Sign up at <a href="https://vercel.com">vercel.com</a> using GitHub</li>
|
|
395
|
+
<li><input disabled="" type="checkbox"> Choose Hobby (free) plan</li>
|
|
396
|
+
<li><input disabled="" type="checkbox"> Authorize Vercel to access GitHub</li>
|
|
368
397
|
</ul>
|
|
369
398
|
</li>
|
|
370
399
|
</ul>
|
|
@@ -437,24 +466,30 @@ npm -v
|
|
|
437
466
|
<tr>
|
|
438
467
|
<th>Plan</th>
|
|
439
468
|
<th>Price</th>
|
|
469
|
+
<th>Claude Code Access</th>
|
|
440
470
|
<th>Best For</th>
|
|
441
|
-
<th>Details</th>
|
|
442
471
|
</tr>
|
|
443
472
|
</thead>
|
|
444
473
|
<tbody><tr>
|
|
445
|
-
<td><strong>
|
|
474
|
+
<td><strong>Free</strong></td>
|
|
475
|
+
<td>$0/month</td>
|
|
476
|
+
<td><i class="ph ph-x-circle" aria-label="error"></i> No access</td>
|
|
477
|
+
<td>Basic chat only</td>
|
|
478
|
+
</tr>
|
|
479
|
+
<tr>
|
|
480
|
+
<td><strong>Pro</strong></td>
|
|
446
481
|
<td>$20/month</td>
|
|
482
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
|
|
447
483
|
<td>Individual developers</td>
|
|
448
|
-
<td>Personal use, full Claude Code access</td>
|
|
449
484
|
</tr>
|
|
450
485
|
<tr>
|
|
451
|
-
<td><strong>
|
|
452
|
-
<td>$
|
|
453
|
-
<td>
|
|
454
|
-
<td>
|
|
486
|
+
<td><strong>Max</strong></td>
|
|
487
|
+
<td>$200/month</td>
|
|
488
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
|
|
489
|
+
<td>Power users, higher limits</td>
|
|
455
490
|
</tr>
|
|
456
491
|
</tbody></table>
|
|
457
|
-
<p><strong>
|
|
492
|
+
<p><strong>Important</strong>: Only Pro and Max plans include Claude Code access. The free Claude.ai plan does NOT support Claude Code. See <a href="https://support.anthropic.com/en/articles/11145838-using-claude-code-with-your-pro-or-max-plan">Using Claude Code with Pro/Max Plans</a></p>
|
|
458
493
|
<h3>Install Claude Code CLI</h3>
|
|
459
494
|
<pre><code class="language-powershell">npm install -g @anthropic/claude-code
|
|
460
495
|
</code></pre>
|
|
@@ -508,11 +543,19 @@ cd my-docs-project
|
|
|
508
543
|
</tr>
|
|
509
544
|
</tbody></table>
|
|
510
545
|
<p>The free Hobby plan is perfect for documentation sites!</p>
|
|
511
|
-
<h3>Create
|
|
546
|
+
<h3>Create GitHub Account First</h3>
|
|
547
|
+
<ol>
|
|
548
|
+
<li>Go to <a href="https://github.com">GitHub</a></li>
|
|
549
|
+
<li>Click <strong>Sign Up</strong></li>
|
|
550
|
+
<li>Create username and verify email</li>
|
|
551
|
+
<li>Complete account setup</li>
|
|
552
|
+
</ol>
|
|
553
|
+
<h3>Create Vercel Account (Requires GitHub)</h3>
|
|
512
554
|
<ol>
|
|
513
555
|
<li>Go to <a href="https://vercel.com">Vercel</a></li>
|
|
514
556
|
<li>Click <strong>Sign Up</strong></li>
|
|
515
|
-
<li>Choose <strong>Continue with
|
|
557
|
+
<li>Choose <strong>Continue with GitHub</strong> (recommended)</li>
|
|
558
|
+
<li>Authorize Vercel to access your GitHub</li>
|
|
516
559
|
<li>Select <strong>Hobby</strong> plan (free)</li>
|
|
517
560
|
</ol>
|
|
518
561
|
<h3>Install Vercel CLI</h3>
|
|
@@ -536,12 +579,42 @@ cd my-docs-project
|
|
|
536
579
|
<h3>3. Deploy to Vercel</h3>
|
|
537
580
|
<pre><code class="language-powershell">doc-builder deploy
|
|
538
581
|
</code></pre>
|
|
539
|
-
<
|
|
582
|
+
<h4>First Deployment Setup Questions</h4>
|
|
583
|
+
<p>You'll be prompted with several questions. Here's what each one means:</p>
|
|
584
|
+
<p><strong>1. "Set up and deploy?"</strong> → Type <code>Y</code> (Yes)</p>
|
|
585
|
+
<ul>
|
|
586
|
+
<li>This confirms you want to deploy your documentation to Vercel</li>
|
|
587
|
+
</ul>
|
|
588
|
+
<p><strong>2. "What is your project name?"</strong> → Example: <code>my-api-docs</code></p>
|
|
589
|
+
<ul>
|
|
590
|
+
<li>This becomes your URL: <code>https://my-api-docs.vercel.app</code></li>
|
|
591
|
+
<li>Also used as the project identifier in Vercel dashboard</li>
|
|
592
|
+
</ul>
|
|
593
|
+
<p> <strong>Naming Requirements:</strong></p>
|
|
594
|
+
<ul>
|
|
595
|
+
<li>Must be <strong>lowercase</strong> only</li>
|
|
596
|
+
<li>Up to 100 characters long</li>
|
|
597
|
+
<li>Can include: letters, numbers, <code>.</code> <code>_</code> <code>-</code></li>
|
|
598
|
+
<li>Cannot contain: <code>---</code> (three consecutive hyphens)</li>
|
|
599
|
+
<li>Must start with a letter</li>
|
|
600
|
+
</ul>
|
|
601
|
+
<p> <strong>Good examples:</strong> <code>my-docs</code>, <code>api-docs-v2</code>, <code>team_handbook</code><br> <strong>Bad examples:</strong> <code>My-Docs</code> (uppercase), <code>123-docs</code> (starts with number), <code>my---docs</code> (triple hyphen)</p>
|
|
602
|
+
<p><strong>3. "Which scope do you want to deploy to?"</strong> → Select your account</p>
|
|
540
603
|
<ul>
|
|
541
|
-
<li
|
|
542
|
-
|
|
543
|
-
<
|
|
544
|
-
<
|
|
604
|
+
<li>Choose your personal account or team name</li>
|
|
605
|
+
</ul>
|
|
606
|
+
<p><strong>4. "Link to existing project?"</strong> → Type <code>N</code> (No) for first time</p>
|
|
607
|
+
<ul>
|
|
608
|
+
<li>Choose <code>Y</code> only if you've already created this project before</li>
|
|
609
|
+
</ul>
|
|
610
|
+
<p><strong>5. "What's the name of your existing project?"</strong> → Skip if you chose No above</p>
|
|
611
|
+
<p><strong>6. "In which directory is your code located?"</strong> → Press Enter (accepts <code>./</code>)</p>
|
|
612
|
+
<ul>
|
|
613
|
+
<li>doc-builder already handles this correctly</li>
|
|
614
|
+
</ul>
|
|
615
|
+
<p><strong>7. "Want to modify these settings?"</strong> → Type <code>N</code> (No)</p>
|
|
616
|
+
<ul>
|
|
617
|
+
<li>The default settings are configured correctly by doc-builder</li>
|
|
545
618
|
</ul>
|
|
546
619
|
<h3>4. Make Site Public</h3>
|
|
547
620
|
<p>After deployment:</p>
|
|
@@ -583,6 +656,29 @@ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
|
|
|
583
656
|
<pre><code class="language-powershell">vercel logout
|
|
584
657
|
vercel login
|
|
585
658
|
</code></pre>
|
|
659
|
+
<h3>Vercel Project Naming Errors</h3>
|
|
660
|
+
<p><strong>Error</strong>: "Invalid project name" or deployment fails</p>
|
|
661
|
+
<p><strong>Common Causes</strong>:</p>
|
|
662
|
+
<ol>
|
|
663
|
+
<li>Project name contains uppercase letters</li>
|
|
664
|
+
<li>Project name starts with a number</li>
|
|
665
|
+
<li>Project name contains invalid characters</li>
|
|
666
|
+
<li>Project name contains <code>---</code> (three hyphens)</li>
|
|
667
|
+
</ol>
|
|
668
|
+
<p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
|
|
669
|
+
<ul>
|
|
670
|
+
<li><strong>Lowercase only</strong>: <code>my-docs</code> <i class="ph ph-check-circle" aria-label="checked"></i>, <code>My-Docs</code> <i class="ph ph-x-circle" aria-label="error"></i></li>
|
|
671
|
+
<li><strong>Start with letter</strong>: <code>api-docs</code> <i class="ph ph-check-circle" aria-label="checked"></i>, <code>123-docs</code> <i class="ph ph-x-circle" aria-label="error"></i></li>
|
|
672
|
+
<li><strong>Valid characters</strong>: Letters, numbers, <code>.</code>, <code>_</code>, <code>-</code></li>
|
|
673
|
+
<li><strong>No triple hyphens</strong>: <code>my-cool-docs</code> <i class="ph ph-check-circle" aria-label="checked"></i>, <code>my---docs</code> <i class="ph ph-x-circle" aria-label="error"></i></li>
|
|
674
|
+
</ul>
|
|
675
|
+
<p><strong>Examples of valid names</strong>:</p>
|
|
676
|
+
<ul>
|
|
677
|
+
<li><code>my-documentation</code></li>
|
|
678
|
+
<li><code>api-docs-v2</code></li>
|
|
679
|
+
<li><code>team_handbook</code></li>
|
|
680
|
+
<li><code>docs.myproject</code></li>
|
|
681
|
+
</ul>
|
|
586
682
|
<h2>Best Practices</h2>
|
|
587
683
|
<h3>Folder Structure</h3>
|
|
588
684
|
<pre><code>Documents/
|
package/html/index.html
CHANGED
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.100Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.100Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
package/html/sitemap.xml
CHANGED
|
@@ -2,103 +2,103 @@
|
|
|
2
2
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
3
3
|
<url>
|
|
4
4
|
<loc>https://doc-builder-delta.vercel.app/404.html</loc>
|
|
5
|
-
<lastmod>2025-07-
|
|
5
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
6
6
|
<changefreq>monthly</changefreq>
|
|
7
7
|
<priority>0.6</priority>
|
|
8
8
|
</url>
|
|
9
9
|
<url>
|
|
10
10
|
<loc>https://doc-builder-delta.vercel.app/README.html</loc>
|
|
11
|
-
<lastmod>2025-07-
|
|
11
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
12
12
|
<changefreq>monthly</changefreq>
|
|
13
13
|
<priority>0.6</priority>
|
|
14
14
|
</url>
|
|
15
15
|
<url>
|
|
16
16
|
<loc>https://doc-builder-delta.vercel.app/claude-workflow-guide.html</loc>
|
|
17
|
-
<lastmod>2025-07-
|
|
17
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
18
18
|
<changefreq>monthly</changefreq>
|
|
19
19
|
<priority>0.8</priority>
|
|
20
20
|
</url>
|
|
21
21
|
<url>
|
|
22
22
|
<loc>https://doc-builder-delta.vercel.app/documentation-index.html</loc>
|
|
23
|
-
<lastmod>2025-07-
|
|
23
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
24
24
|
<changefreq>monthly</changefreq>
|
|
25
25
|
<priority>0.6</priority>
|
|
26
26
|
</url>
|
|
27
27
|
<url>
|
|
28
28
|
<loc>https://doc-builder-delta.vercel.app/guides/authentication-guide.html</loc>
|
|
29
|
-
<lastmod>2025-07-
|
|
29
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
30
30
|
<changefreq>monthly</changefreq>
|
|
31
31
|
<priority>0.8</priority>
|
|
32
32
|
</url>
|
|
33
33
|
<url>
|
|
34
34
|
<loc>https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html</loc>
|
|
35
|
-
<lastmod>2025-07-
|
|
35
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
36
36
|
<changefreq>monthly</changefreq>
|
|
37
37
|
<priority>0.8</priority>
|
|
38
38
|
</url>
|
|
39
39
|
<url>
|
|
40
40
|
<loc>https://doc-builder-delta.vercel.app/guides/document-standards.html</loc>
|
|
41
|
-
<lastmod>2025-07-
|
|
41
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
42
42
|
<changefreq>monthly</changefreq>
|
|
43
43
|
<priority>0.8</priority>
|
|
44
44
|
</url>
|
|
45
45
|
<url>
|
|
46
46
|
<loc>https://doc-builder-delta.vercel.app/guides/documentation-standards.html</loc>
|
|
47
|
-
<lastmod>2025-07-
|
|
47
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
48
48
|
<changefreq>monthly</changefreq>
|
|
49
49
|
<priority>0.8</priority>
|
|
50
50
|
</url>
|
|
51
51
|
<url>
|
|
52
52
|
<loc>https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html</loc>
|
|
53
|
-
<lastmod>2025-07-
|
|
53
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
54
54
|
<changefreq>monthly</changefreq>
|
|
55
55
|
<priority>0.8</priority>
|
|
56
56
|
</url>
|
|
57
57
|
<url>
|
|
58
58
|
<loc>https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html</loc>
|
|
59
|
-
<lastmod>2025-07-
|
|
59
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
60
60
|
<changefreq>monthly</changefreq>
|
|
61
61
|
<priority>0.8</priority>
|
|
62
62
|
</url>
|
|
63
63
|
<url>
|
|
64
64
|
<loc>https://doc-builder-delta.vercel.app/guides/seo-guide.html</loc>
|
|
65
|
-
<lastmod>2025-07-
|
|
65
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
66
66
|
<changefreq>monthly</changefreq>
|
|
67
67
|
<priority>0.8</priority>
|
|
68
68
|
</url>
|
|
69
69
|
<url>
|
|
70
70
|
<loc>https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html</loc>
|
|
71
|
-
<lastmod>2025-07-
|
|
71
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
72
72
|
<changefreq>monthly</changefreq>
|
|
73
73
|
<priority>0.8</priority>
|
|
74
74
|
</url>
|
|
75
75
|
<url>
|
|
76
76
|
<loc>https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html</loc>
|
|
77
|
-
<lastmod>2025-07-
|
|
77
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
78
78
|
<changefreq>monthly</changefreq>
|
|
79
79
|
<priority>0.8</priority>
|
|
80
80
|
</url>
|
|
81
81
|
<url>
|
|
82
82
|
<loc>https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html</loc>
|
|
83
|
-
<lastmod>2025-07-
|
|
83
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
84
84
|
<changefreq>monthly</changefreq>
|
|
85
85
|
<priority>0.8</priority>
|
|
86
86
|
</url>
|
|
87
87
|
<url>
|
|
88
88
|
<loc>https://doc-builder-delta.vercel.app/index.html</loc>
|
|
89
|
-
<lastmod>2025-07-
|
|
89
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
90
90
|
<changefreq>weekly</changefreq>
|
|
91
91
|
<priority>1.0</priority>
|
|
92
92
|
</url>
|
|
93
93
|
<url>
|
|
94
94
|
<loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
|
|
95
|
-
<lastmod>2025-07-
|
|
95
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
96
96
|
<changefreq>monthly</changefreq>
|
|
97
97
|
<priority>0.8</priority>
|
|
98
98
|
</url>
|
|
99
99
|
<url>
|
|
100
100
|
<loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
|
|
101
|
-
<lastmod>2025-07-
|
|
101
|
+
<lastmod>2025-07-22T16:04:34.197Z</lastmod>
|
|
102
102
|
<changefreq>monthly</changefreq>
|
|
103
103
|
<priority>0.8</priority>
|
|
104
104
|
</url>
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.185Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.185Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T16:04:34.187Z",
|
|
66
|
+
"dateModified": "2025-07-22T16:04:34.187Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.19">Last updated: Jul 22, 2025, 04:04 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|