@knowcode/doc-builder 1.5.12 → 1.5.14
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/CHANGELOG.md +31 -0
- package/assets/css/notion-style.css +32 -0
- package/doc-builder.config.js +2 -1
- package/html/README.html +26 -24
- package/html/css/notion-style.css +32 -0
- package/html/documentation-index.html +23 -9
- package/html/guides/authentication-guide.html +20 -18
- package/html/guides/claude-workflow-guide.html +25 -23
- package/html/guides/documentation-standards.html +22 -20
- package/html/guides/google-site-verification-guide.html +7 -5
- package/html/guides/phosphor-icons-guide.html +487 -0
- package/html/guides/seo-guide.html +11 -9
- package/html/guides/seo-optimization-guide.html +40 -38
- package/html/guides/troubleshooting-guide.html +40 -28
- package/html/index.html +26 -24
- package/html/sitemap.xml +21 -15
- package/html/vercel-cli-setup-guide.html +115 -174
- package/html/vercel-first-time-setup-guide.html +135 -217
- package/lib/config.js +8 -2
- package/lib/core-builder.js +7 -2
- package/lib/emoji-mapper.js +267 -0
- package/package.json +1 -1
|
@@ -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-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:08:52.136Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:08:52.136Z",
|
|
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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 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
|
|
156
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
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
|
|
@@ -163,6 +164,7 @@
|
|
|
163
164
|
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
164
165
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
165
166
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
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>
|
|
166
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>
|
|
167
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>
|
|
168
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>
|
|
@@ -174,7 +176,7 @@
|
|
|
174
176
|
<main class="content">
|
|
175
177
|
<div class="content-inner">
|
|
176
178
|
<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>:
|
|
179
|
+
<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
180
|
<h2>Overview</h2>
|
|
179
181
|
<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
182
|
<h2>Why SEO Matters for Documentation</h2>
|
|
@@ -308,15 +310,15 @@ keywords: ["authentication", "security", "password prot
|
|
|
308
310
|
<h3>Examples</h3>
|
|
309
311
|
<p>Good titles:</p>
|
|
310
312
|
<ul>
|
|
311
|
-
<li
|
|
312
|
-
<li
|
|
313
|
-
<li
|
|
313
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "Authentication Guide | Doc Builder" (38 chars)</li>
|
|
314
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "SEO Best Practices for Documentation | MyDocs" (45 chars)</li>
|
|
315
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "Quick Start: Deploy to Vercel | Doc Builder" (43 chars)</li>
|
|
314
316
|
</ul>
|
|
315
317
|
<p>Bad titles:</p>
|
|
316
318
|
<ul>
|
|
317
|
-
<li
|
|
318
|
-
<li
|
|
319
|
-
<li
|
|
319
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Guide" (5 chars - too short)</li>
|
|
320
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "The Complete Comprehensive Guide to Setting Up Authentication and Security for Your Documentation Website | Doc Builder" (118 chars - too long)</li>
|
|
321
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Page Title | Site Name | Category | Subcategory" (keyword stuffing)</li>
|
|
320
322
|
</ul>
|
|
321
323
|
<h2>Meta Descriptions</h2>
|
|
322
324
|
<h3>Best Practices</h3>
|
|
@@ -338,13 +340,13 @@ keywords: ["authentication", "security", "password prot
|
|
|
338
340
|
<h3>Examples</h3>
|
|
339
341
|
<p>Good descriptions:</p>
|
|
340
342
|
<ul>
|
|
341
|
-
<li
|
|
342
|
-
<li
|
|
343
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "Learn how to implement authentication in your documentation site. Step-by-step guide with code examples and security best practices." (139 chars)</li>
|
|
344
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> "Optimize your documentation for search engines with our comprehensive SEO guide. Covers titles, descriptions, and keyword strategies." (143 chars)</li>
|
|
343
345
|
</ul>
|
|
344
346
|
<p>Bad descriptions:</p>
|
|
345
347
|
<ul>
|
|
346
|
-
<li
|
|
347
|
-
<li
|
|
348
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "This page is about authentication." (35 chars - too short)</li>
|
|
349
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Authentication authentication authentication..." (keyword stuffing)</li>
|
|
348
350
|
</ul>
|
|
349
351
|
<h2>Keywords Strategy</h2>
|
|
350
352
|
<h3>Modern Keyword Approach (2025)</h3>
|
|
@@ -388,23 +390,23 @@ doc-builder seo-check html/guide.html
|
|
|
388
390
|
<h3>What It Analyzes in HTML</h3>
|
|
389
391
|
<p>The command inspects the actual HTML output that search engines see:</p>
|
|
390
392
|
<ul>
|
|
391
|
-
<li
|
|
392
|
-
<li
|
|
393
|
-
<li
|
|
394
|
-
<li
|
|
395
|
-
<li
|
|
396
|
-
<li
|
|
397
|
-
<li
|
|
398
|
-
<li
|
|
393
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Title tags</strong> - Presence and optimal length (50-60 chars)</li>
|
|
394
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Meta descriptions</strong> - Quality and character count (140-160)</li>
|
|
395
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Keywords meta tag</strong> - Presence of relevant keywords</li>
|
|
396
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Canonical URLs</strong> - Prevents duplicate content penalties</li>
|
|
397
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>H1 tags</strong> - Ensures proper heading structure</li>
|
|
398
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Open Graph tags</strong> - Social media optimization</li>
|
|
399
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Twitter Card tags</strong> - Twitter/X optimization</li>
|
|
400
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Structured data</strong> - JSON-LD implementation</li>
|
|
399
401
|
</ul>
|
|
400
402
|
<h3>Example Output</h3>
|
|
401
|
-
<pre><code
|
|
403
|
+
<pre><code><i class="ph ph-magnifying-glass" aria-label="search"></i> Analyzing SEO in generated HTML files...
|
|
402
404
|
|
|
403
|
-
|
|
405
|
+
<i class="ph ph-chart-bar" aria-label="chart"></i> SEO Analysis Complete
|
|
404
406
|
|
|
405
407
|
Analyzed 14 files
|
|
406
408
|
|
|
407
|
-
|
|
409
|
+
<i class="ph ph-x-circle" aria-label="error"></i> Found 2 issues:
|
|
408
410
|
|
|
409
411
|
guides/api.html:
|
|
410
412
|
Title too long (75 chars, max 60)
|
|
@@ -413,7 +415,7 @@ Analyzed 14 files
|
|
|
413
415
|
setup.html:
|
|
414
416
|
Missing meta description
|
|
415
417
|
|
|
416
|
-
|
|
418
|
+
<i class="ph ph-lightbulb" aria-label="idea"></i> 8 suggestions:
|
|
417
419
|
|
|
418
420
|
index.html: Description too short (95 chars, ideal 140-160)
|
|
419
421
|
guides/auth.html: No keywords meta tag found
|
|
@@ -478,28 +480,28 @@ Your content here...
|
|
|
478
480
|
<h2>Common SEO Mistakes to Avoid</h2>
|
|
479
481
|
<h3>1. Duplicate Content</h3>
|
|
480
482
|
<ul>
|
|
481
|
-
<li
|
|
482
|
-
<li
|
|
483
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Same description on multiple pages</li>
|
|
484
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Unique descriptions for each page</li>
|
|
483
485
|
</ul>
|
|
484
486
|
<h3>2. Keyword Stuffing</h3>
|
|
485
487
|
<ul>
|
|
486
|
-
<li
|
|
487
|
-
<li
|
|
488
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Guide guide documentation guide tutorial guide"</li>
|
|
489
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Natural keyword usage in context</li>
|
|
488
490
|
</ul>
|
|
489
491
|
<h3>3. Ignoring Mobile</h3>
|
|
490
492
|
<ul>
|
|
491
|
-
<li
|
|
492
|
-
<li
|
|
493
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Long titles that get cut off on mobile</li>
|
|
494
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Test how titles appear on different devices</li>
|
|
493
495
|
</ul>
|
|
494
496
|
<h3>4. Missing Descriptions</h3>
|
|
495
497
|
<ul>
|
|
496
|
-
<li
|
|
497
|
-
<li
|
|
498
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Leaving description blank</li>
|
|
499
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Always provide meaningful descriptions</li>
|
|
498
500
|
</ul>
|
|
499
501
|
<h3>5. Generic Titles</h3>
|
|
500
502
|
<ul>
|
|
501
|
-
<li
|
|
502
|
-
<li
|
|
503
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> "Documentation", "Guide", "Page 1"</li>
|
|
504
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Specific, descriptive titles</li>
|
|
503
505
|
</ul>
|
|
504
506
|
<h2>SEO Checklist</h2>
|
|
505
507
|
<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-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:08:52.140Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:08:52.140Z",
|
|
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.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 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
|
|
156
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
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
|
|
@@ -163,6 +164,7 @@
|
|
|
163
164
|
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
164
165
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
165
166
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
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>
|
|
166
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>
|
|
167
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>
|
|
168
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>
|
|
@@ -174,7 +176,7 @@
|
|
|
174
176
|
<main class="content">
|
|
175
177
|
<div class="content-inner">
|
|
176
178
|
<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>:
|
|
179
|
+
<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
180
|
<h2>Overview</h2>
|
|
179
181
|
<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
182
|
<h2>NPX Cache Issues</h2>
|
|
@@ -182,10 +184,10 @@
|
|
|
182
184
|
<p>The most common issue users face is npx caching an older version of doc-builder.</p>
|
|
183
185
|
<p><strong>Symptoms:</strong></p>
|
|
184
186
|
<ul>
|
|
185
|
-
<li
|
|
186
|
-
<li
|
|
187
|
-
<li
|
|
188
|
-
<li
|
|
187
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
|
|
188
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> New features aren't available despite updating</li>
|
|
189
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Bug fixes don't appear to be working</li>
|
|
190
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Version shown doesn't match npm registry</li>
|
|
189
191
|
</ul>
|
|
190
192
|
<p><strong>Example:</strong></p>
|
|
191
193
|
<pre><code class="language-bash">$ npx @knowcode/doc-builder --version
|
|
@@ -249,10 +251,10 @@ npx doc-builder deploy # Uses local version
|
|
|
249
251
|
</li>
|
|
250
252
|
<li><p><strong>Ensure correct file extensions:</strong></p>
|
|
251
253
|
<ul>
|
|
252
|
-
<li
|
|
253
|
-
<li
|
|
254
|
-
<li
|
|
255
|
-
<li
|
|
254
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
|
|
255
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
|
|
256
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
|
|
257
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
|
|
256
258
|
</ul>
|
|
257
259
|
</li>
|
|
258
260
|
<li><p><strong>Use custom input directory:</strong></p>
|
|
@@ -285,13 +287,16 @@ npm install -g vercel
|
|
|
285
287
|
|
|
286
288
|
# Verify installation
|
|
287
289
|
vercel --version
|
|
290
|
+
|
|
291
|
+
# Then retry deployment
|
|
292
|
+
npx @knowcode/doc-builder deploy
|
|
288
293
|
</code></pre>
|
|
289
294
|
<h3>Deployment Fails</h3>
|
|
290
295
|
<p><strong>Common causes:</strong></p>
|
|
291
296
|
<ol>
|
|
292
|
-
<li><p><strong>
|
|
293
|
-
<pre><code class="language-bash">#
|
|
294
|
-
|
|
297
|
+
<li><p><strong>Not Logged Into Vercel</strong></p>
|
|
298
|
+
<pre><code class="language-bash"># Login to Vercel first
|
|
299
|
+
vercel login
|
|
295
300
|
</code></pre>
|
|
296
301
|
</li>
|
|
297
302
|
<li><p><strong>Build Not Complete</strong></p>
|
|
@@ -300,21 +305,24 @@ npx @knowcode/doc-builder build
|
|
|
300
305
|
npx @knowcode/doc-builder deploy
|
|
301
306
|
</code></pre>
|
|
302
307
|
</li>
|
|
303
|
-
<li><p><strong>
|
|
308
|
+
<li><p><strong>Project Name Already Taken</strong></p>
|
|
304
309
|
<ul>
|
|
305
|
-
<li>
|
|
306
|
-
<li>
|
|
310
|
+
<li>Choose a different project name</li>
|
|
311
|
+
<li>Or delete the existing project in Vercel dashboard</li>
|
|
307
312
|
</ul>
|
|
308
313
|
</li>
|
|
309
314
|
</ol>
|
|
310
315
|
<h3>Wrong Production URL Displayed</h3>
|
|
311
|
-
<p><strong>Problem:</strong> Deployment shows incorrect URL
|
|
312
|
-
<p><strong>
|
|
313
|
-
<
|
|
314
|
-
<pre><code class="language-bash"># Update to latest version
|
|
316
|
+
<p><strong>Problem:</strong> Deployment shows incorrect URL</p>
|
|
317
|
+
<p><strong>Solution 1:</strong> Update to latest version</p>
|
|
318
|
+
<pre><code class="language-bash"># Clear cache and update
|
|
315
319
|
npx clear-npx-cache
|
|
316
320
|
npx @knowcode/doc-builder@latest deploy
|
|
317
321
|
</code></pre>
|
|
322
|
+
<p><strong>Solution 2:</strong> Set custom URL</p>
|
|
323
|
+
<pre><code class="language-bash"># Set your actual production URL
|
|
324
|
+
npx @knowcode/doc-builder set-production-url https://my-docs.vercel.app
|
|
325
|
+
</code></pre>
|
|
318
326
|
<h2>Configuration Issues</h2>
|
|
319
327
|
<h3>Config File Not Loading</h3>
|
|
320
328
|
<p><strong>Symptoms:</strong></p>
|
|
@@ -326,9 +334,9 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
326
334
|
<ol>
|
|
327
335
|
<li><p><strong>Check file name:</strong></p>
|
|
328
336
|
<ul>
|
|
329
|
-
<li
|
|
330
|
-
<li
|
|
331
|
-
<li
|
|
337
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
|
|
338
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
|
|
339
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
|
|
332
340
|
</ul>
|
|
333
341
|
</li>
|
|
334
342
|
<li><p><strong>Verify export format:</strong></p>
|
|
@@ -476,7 +484,7 @@ npm --version
|
|
|
476
484
|
</tr>
|
|
477
485
|
<tr>
|
|
478
486
|
<td>Vercel deploy fails</td>
|
|
479
|
-
<td><code>
|
|
487
|
+
<td><code>vercel login</code> then retry</td>
|
|
480
488
|
</tr>
|
|
481
489
|
<tr>
|
|
482
490
|
<td>No markdown found</td>
|
|
@@ -494,6 +502,10 @@ npm --version
|
|
|
494
502
|
<td>Config not loading</td>
|
|
495
503
|
<td>Check filename and format</td>
|
|
496
504
|
</tr>
|
|
505
|
+
<tr>
|
|
506
|
+
<td>404 after deploy</td>
|
|
507
|
+
<td>Check Deployment Protection settings</td>
|
|
508
|
+
</tr>
|
|
497
509
|
</tbody></table>
|
|
498
510
|
<hr>
|
|
499
511
|
<h2>Document History</h2>
|
package/html/index.html
CHANGED
|
@@ -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-
|
|
65
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T11:08:51.999Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:08:51.999Z",
|
|
66
67
|
"mainEntityOfPage": {
|
|
67
68
|
"@type": "WebPage",
|
|
68
69
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -95,7 +96,7 @@
|
|
|
95
96
|
|
|
96
97
|
<div class="header-actions">
|
|
97
98
|
<div class="deployment-info">
|
|
98
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.13">Last updated: Jul 22, 2025, 11:08 AM UTC</span>
|
|
99
100
|
</div>
|
|
100
101
|
|
|
101
102
|
|
|
@@ -146,8 +147,8 @@
|
|
|
146
147
|
<div class="nav-content" >
|
|
147
148
|
<a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
148
149
|
<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>
|
|
149
|
-
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing
|
|
150
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide
|
|
150
|
+
<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>
|
|
151
|
+
<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>
|
|
151
152
|
<div class="nav-section" data-level="1">
|
|
152
153
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
153
154
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -157,6 +158,7 @@
|
|
|
157
158
|
<a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
158
159
|
<a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
|
|
159
160
|
<a href="/guides/google-site-verification-guide.html" class="nav-item" data-tooltip="Google Search Console verification allows you to: Monitor your site's performance in Google Search Submit sitemaps for better indexing View search..."><i class="fas fa-file-alt"></i> Google Site Verification Guide</a>
|
|
161
|
+
<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>
|
|
160
162
|
<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>
|
|
161
163
|
<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>
|
|
162
164
|
<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>
|
|
@@ -172,7 +174,7 @@
|
|
|
172
174
|
<p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
|
|
173
175
|
</blockquote>
|
|
174
176
|
<p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><img src="https://img.shields.io/npm/v/@knowcode/doc-builder" alt="npm version"></a><br><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a></p>
|
|
175
|
-
<h2
|
|
177
|
+
<h2><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h2>
|
|
176
178
|
<p>Create stunning documentation sites in minutes:</p>
|
|
177
179
|
<pre><code class="language-bash"># Install globally
|
|
178
180
|
npm install -g @knowcode/doc-builder
|
|
@@ -180,45 +182,45 @@ npm install -g @knowcode/doc-builder
|
|
|
180
182
|
# Or use with npx
|
|
181
183
|
npx @knowcode/doc-builder@latest deploy
|
|
182
184
|
</code></pre>
|
|
183
|
-
<h2
|
|
184
|
-
<h3
|
|
185
|
+
<h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
|
|
186
|
+
<h3><i class="ph ph-palette" aria-label="design"></i> Beautiful Design</h3>
|
|
185
187
|
<ul>
|
|
186
188
|
<li><strong>Notion-inspired UI</strong> - Clean, modern interface that users love</li>
|
|
187
189
|
<li><strong>Dark mode support</strong> - Automatic theme switching</li>
|
|
188
190
|
<li><strong>Responsive layout</strong> - Perfect on desktop and mobile</li>
|
|
189
191
|
<li><strong>Syntax highlighting</strong> - Beautiful code blocks with language support</li>
|
|
190
192
|
</ul>
|
|
191
|
-
<h3
|
|
193
|
+
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Powerful Search & Navigation</h3>
|
|
192
194
|
<ul>
|
|
193
195
|
<li><strong>Full-text search</strong> - Find anything instantly</li>
|
|
194
196
|
<li><strong>Smart navigation</strong> - Hierarchical folder structure</li>
|
|
195
197
|
<li><strong>Breadcrumbs</strong> - Always know where you are</li>
|
|
196
198
|
<li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
|
|
197
199
|
</ul>
|
|
198
|
-
<h3
|
|
200
|
+
<h3><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Support</h3>
|
|
199
201
|
<ul>
|
|
200
202
|
<li><strong>Mermaid diagrams</strong> - Flowcharts, sequence diagrams, and more</li>
|
|
201
203
|
<li><strong>GitHub-flavored markdown</strong> - Tables, task lists, and strikethrough</li>
|
|
202
204
|
<li><strong>Interactive tooltips</strong> - Document summaries on hover</li>
|
|
203
205
|
<li><strong>Version tracking</strong> - Know which version built your docs</li>
|
|
204
206
|
</ul>
|
|
205
|
-
<h3
|
|
207
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Easy Deployment</h3>
|
|
206
208
|
<ul>
|
|
207
209
|
<li><strong>One-command deploy</strong> - Push to Vercel instantly</li>
|
|
208
210
|
<li><strong>Static site generation</strong> - Fast, secure, and scalable</li>
|
|
209
211
|
<li><strong>Custom domains</strong> - Your docs, your brand</li>
|
|
210
212
|
<li><strong>Preview deployments</strong> - Test before going live</li>
|
|
211
213
|
</ul>
|
|
212
|
-
<h2
|
|
214
|
+
<h2><i class="ph ph-book-open" aria-label="reading"></i> Documentation</h2>
|
|
213
215
|
<p>Visit our <a href="https://www.npmjs.com/package/@knowcode/doc-builder">official documentation</a> for detailed guides and API reference.</p>
|
|
214
|
-
<h2
|
|
216
|
+
<h2><i class="ph ph-target" aria-label="goal"></i> Perfect For</h2>
|
|
215
217
|
<ul>
|
|
216
218
|
<li><strong>Open source projects</strong> - Beautiful docs for your community</li>
|
|
217
219
|
<li><strong>Technical teams</strong> - Internal documentation that developers actually use</li>
|
|
218
220
|
<li><strong>API documentation</strong> - Clear, searchable API references</li>
|
|
219
221
|
<li><strong>Knowledge bases</strong> - Organize and share team knowledge</li>
|
|
220
222
|
</ul>
|
|
221
|
-
<h2
|
|
223
|
+
<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
|
|
222
224
|
<h3>1. Initialize Your Project</h3>
|
|
223
225
|
<pre><code class="language-bash">npx @knowcode/doc-builder init
|
|
224
226
|
</code></pre>
|
|
@@ -236,9 +238,9 @@ npm install amazing-package
|
|
|
236
238
|
|
|
237
239
|
## Features
|
|
238
240
|
|
|
239
|
-
-
|
|
240
|
-
-
|
|
241
|
-
-
|
|
241
|
+
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
|
|
242
|
+
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature two
|
|
243
|
+
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature three
|
|
242
244
|
</code></pre>
|
|
243
245
|
<h3>3. Build & Preview</h3>
|
|
244
246
|
<pre><code class="language-bash"># Build your site
|
|
@@ -250,7 +252,7 @@ npx doc-builder serve
|
|
|
250
252
|
<h3>4. Deploy to Vercel</h3>
|
|
251
253
|
<pre><code class="language-bash">npx doc-builder deploy
|
|
252
254
|
</code></pre>
|
|
253
|
-
<h2
|
|
255
|
+
<h2><i class="ph ph-palette" aria-label="design"></i> Customization</h2>
|
|
254
256
|
<p>Configure your site with <code>doc-builder.config.js</code>:</p>
|
|
255
257
|
<pre><code class="language-javascript">module.exports = {
|
|
256
258
|
siteName: 'Your Amazing Docs',
|
|
@@ -262,7 +264,7 @@ npx doc-builder serve
|
|
|
262
264
|
}
|
|
263
265
|
};
|
|
264
266
|
</code></pre>
|
|
265
|
-
<h2
|
|
267
|
+
<h2><i class="ph ph-chart-bar" aria-label="chart"></i> Mermaid Diagram Support</h2>
|
|
266
268
|
<p>Create beautiful diagrams in your markdown:</p>
|
|
267
269
|
<div class="mermaid-wrapper">
|
|
268
270
|
<div class="mermaid-title">Diagram</div>
|
|
@@ -274,13 +276,13 @@ npx doc-builder serve
|
|
|
274
276
|
style A fill:#e1f5fe
|
|
275
277
|
style D fill:#c8e6c9</div>
|
|
276
278
|
</div>
|
|
277
|
-
<h2
|
|
279
|
+
<h2><i class="ph ph-lock" aria-label="locked"></i> Optional Authentication</h2>
|
|
278
280
|
<p>Protect sensitive documentation with built-in authentication:</p>
|
|
279
281
|
<pre><code class="language-javascript">features: {
|
|
280
282
|
authentication: true
|
|
281
283
|
}
|
|
282
284
|
</code></pre>
|
|
283
|
-
<h2
|
|
285
|
+
<h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why doc-builder?</h2>
|
|
284
286
|
<ul>
|
|
285
287
|
<li><strong>Zero configuration</strong> - Works out of the box</li>
|
|
286
288
|
<li><strong>Lightning fast</strong> - Static site generation for instant loading</li>
|
|
@@ -289,13 +291,13 @@ npx doc-builder serve
|
|
|
289
291
|
<li><strong>Version control</strong> - Track changes with Git</li>
|
|
290
292
|
<li><strong>Open source</strong> - MIT licensed</li>
|
|
291
293
|
</ul>
|
|
292
|
-
<h2
|
|
294
|
+
<h2><i class="ph ph-handshake" aria-label="partnership"></i> Contributing</h2>
|
|
293
295
|
<p>We welcome contributions! Check out our <a href="https://github.com/knowcode/doc-builder">contribution guide</a> to get started.</p>
|
|
294
|
-
<h2
|
|
296
|
+
<h2><i class="ph ph-note-pencil" aria-label="edit"></i> License</h2>
|
|
295
297
|
<p>MIT © KnowCode</p>
|
|
296
298
|
<hr>
|
|
297
299
|
<div align="center">
|
|
298
|
-
<p>Built with
|
|
300
|
+
<p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
|
|
299
301
|
<p>
|
|
300
302
|
<a href="https://www.npmjs.com/package/@knowcode/doc-builder">npm</a> •
|
|
301
303
|
<a href="https://github.com/knowcode/doc-builder">GitHub</a> •
|