@knowcode/doc-builder 1.9.20 → 1.9.21
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/cli.js +15 -1
- package/doc-builder.config.js +4 -2
- package/doc-builder.config.js.backup.1754567425847 +124 -0
- package/html/README.html +3 -3
- package/html/about-doc-builder.html +3 -3
- package/html/documentation-index.html +3 -3
- package/html/guides/authentication-default-change.html +3 -3
- package/html/guides/authentication-guide.html +3 -3
- package/html/guides/claude-workflow-guide.html +3 -3
- package/html/guides/configuration-guide.html +3 -3
- package/html/guides/documentation-standards.html +3 -3
- package/html/guides/html-embedding-guide.html +3 -3
- package/html/guides/image-modal-guide.html +3 -3
- package/html/guides/phosphor-icons-guide.html +3 -3
- package/html/guides/private-directory-authentication-troubleshooting.html +3 -3
- package/html/guides/private-directory-authentication.html +3 -3
- package/html/guides/public-site-deployment.html +3 -3
- package/html/guides/search-engine-verification-guide.html +3 -3
- package/html/guides/seo-guide.html +3 -3
- package/html/guides/seo-optimization-guide.html +3 -3
- package/html/guides/supabase-authentication-complete-guide.html +3 -3
- package/html/guides/troubleshooting-guide.html +3 -3
- package/html/guides/windows-setup-guide.html +3 -3
- package/html/image-modal-test.html +3 -3
- package/html/index.html +3 -3
- package/html/private/cache-control-anti-pattern.html +3 -3
- package/html/private/launch/README.html +3 -3
- package/html/private/launch/auth-cleanup-summary.html +3 -3
- package/html/private/launch/bubble-plugin-specification.html +3 -3
- package/html/private/launch/go-to-market-strategy.html +3 -3
- package/html/private/launch/launch-announcements.html +3 -3
- package/html/private/launch/vercel-deployment-auth-setup.html +3 -3
- package/html/private/next-steps-walkthrough.html +3 -3
- package/html/private/supabase-auth-implementation-completed.html +3 -3
- package/html/private/supabase-auth-implementation-plan.html +3 -3
- package/html/private/supabase-auth-integration-plan.html +3 -3
- package/html/private/supabase-auth-setup-guide.html +3 -3
- package/html/private/test-private-doc.html +3 -3
- package/html/private/user-management-tooling.html +3 -3
- package/html/prompts/beautiful-documentation-design.html +3 -3
- package/html/prompts/markdown-document-standards.html +3 -3
- package/html/prompts/project-rename-strategy-sasha-publish.html +3 -3
- package/html/sitemap.xml +59 -59
- package/html/test-questions/how-does-it-work%3F.html +3 -3
- package/html/test-questions/step-1%3A%20getting-started.html +3 -3
- package/html/test-questions/what-is-the-purpose.html +3 -3
- package/html/vercel-cli-setup-guide.html +3 -3
- package/html/vercel-first-time-setup-guide.html +3 -3
- package/html-static/404.html +115 -0
- package/html-static/README.html +456 -0
- package/html-static/about-doc-builder.html +425 -0
- package/html-static/css/notion-style.css +2426 -0
- package/html-static/documentation-index.html +405 -0
- package/html-static/guides/authentication-default-change.html +304 -0
- package/html-static/guides/authentication-guide.html +443 -0
- package/html-static/guides/claude-workflow-guide.html +1008 -0
- package/html-static/guides/configuration-guide.html +406 -0
- package/html-static/guides/documentation-standards.html +628 -0
- package/html-static/guides/html-embedding-guide.html +395 -0
- package/html-static/guides/image-modal-guide.html +449 -0
- package/html-static/guides/phosphor-icons-guide.html +518 -0
- package/html-static/guides/private-directory-authentication-troubleshooting.html +489 -0
- package/html-static/guides/private-directory-authentication.html +475 -0
- package/html-static/guides/public-site-deployment.html +365 -0
- package/html-static/guides/search-engine-verification-guide.html +476 -0
- package/html-static/guides/seo-guide.html +595 -0
- package/html-static/guides/seo-optimization-guide.html +821 -0
- package/html-static/guides/supabase-authentication-complete-guide.html +800 -0
- package/html-static/guides/troubleshooting-guide.html +567 -0
- package/html-static/guides/windows-setup-guide.html +793 -0
- package/html-static/image-modal-test.html +252 -0
- package/html-static/index.html +456 -0
- package/html-static/js/main.js +1692 -0
- package/html-static/prompts/beautiful-documentation-design.html +718 -0
- package/html-static/prompts/markdown-document-standards.html +356 -0
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +464 -0
- package/html-static/robots.txt +5 -0
- package/html-static/sitemap.xml +189 -0
- package/html-static/test-questions/how-does-it-work%3F.html +228 -0
- package/html-static/test-questions/step-1%3A%20getting-started.html +223 -0
- package/html-static/test-questions/what-is-the-purpose.html +227 -0
- package/html-static/vercel-cli-setup-guide.html +429 -0
- package/html-static/vercel-first-time-setup-guide.html +388 -0
- package/lib/config.js +9 -2
- package/lib/core-builder.js +148 -4
- package/package.json +1 -1
|
@@ -0,0 +1,567 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<meta name="description" content="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.">
|
|
7
|
+
<title>Troubleshooting Guide for @knowcode/doc-builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
|
|
10
|
+
<meta name="author" content="Lindsay Smith">
|
|
11
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, issues, check">
|
|
12
|
+
<meta name="robots" content="index, follow">
|
|
13
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
|
|
14
|
+
|
|
15
|
+
<!-- Open Graph / Facebook -->
|
|
16
|
+
<meta property="og:type" content="article">
|
|
17
|
+
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
|
|
18
|
+
<meta property="og:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
19
|
+
<meta property="og:description" content="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.">
|
|
20
|
+
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
21
|
+
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
22
|
+
<meta property="og:locale" content="en_US">
|
|
23
|
+
|
|
24
|
+
<!-- Twitter Card -->
|
|
25
|
+
<meta name="twitter:card" content="summary_large_image">
|
|
26
|
+
<meta name="twitter:site" content="@planbbackups">
|
|
27
|
+
<meta name="twitter:creator" content="@planbbackups">
|
|
28
|
+
<meta name="twitter:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
29
|
+
<meta name="twitter:description" content="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.">
|
|
30
|
+
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
31
|
+
|
|
32
|
+
<!-- Custom Meta Tags -->
|
|
33
|
+
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
34
|
+
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
35
|
+
|
|
36
|
+
<!-- Fonts -->
|
|
37
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
38
|
+
|
|
39
|
+
<!-- Icons -->
|
|
40
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
41
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
42
|
+
|
|
43
|
+
<!-- Mermaid -->
|
|
44
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
45
|
+
|
|
46
|
+
<!-- Styles -->
|
|
47
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
<!-- Favicon -->
|
|
52
|
+
<link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>✨</text></svg>">
|
|
53
|
+
|
|
54
|
+
<script type="application/ld+json">
|
|
55
|
+
{
|
|
56
|
+
"@context": "https://schema.org",
|
|
57
|
+
"@type": "TechArticle",
|
|
58
|
+
"headline": "Troubleshooting Guide for @knowcode/doc-builder",
|
|
59
|
+
"description": "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.",
|
|
60
|
+
"author": {
|
|
61
|
+
"@type": "Person",
|
|
62
|
+
"name": "Lindsay Smith"
|
|
63
|
+
},
|
|
64
|
+
"publisher": {
|
|
65
|
+
"@type": "Organization",
|
|
66
|
+
"name": "Knowcode Ltd",
|
|
67
|
+
"url": "https://knowcode.tech"
|
|
68
|
+
},
|
|
69
|
+
"datePublished": "2025-08-07T11:50:26.092Z",
|
|
70
|
+
"dateModified": "2025-08-07T11:50:26.092Z",
|
|
71
|
+
"mainEntityOfPage": {
|
|
72
|
+
"@type": "WebPage",
|
|
73
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
|
|
74
|
+
},
|
|
75
|
+
"breadcrumb": {
|
|
76
|
+
"@type": "BreadcrumbList",
|
|
77
|
+
"itemListElement": [
|
|
78
|
+
{
|
|
79
|
+
"@type": "ListItem",
|
|
80
|
+
"position": 1,
|
|
81
|
+
"name": "@knowcode/doc-builder",
|
|
82
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"@type": "ListItem",
|
|
86
|
+
"position": 2,
|
|
87
|
+
"name": "Guides",
|
|
88
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"@type": "ListItem",
|
|
92
|
+
"position": 3,
|
|
93
|
+
"name": "Troubleshooting Guide",
|
|
94
|
+
"item": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
</script>
|
|
100
|
+
</head>
|
|
101
|
+
<body>
|
|
102
|
+
<!-- Header -->
|
|
103
|
+
<header class="header">
|
|
104
|
+
<div class="header-content">
|
|
105
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
106
|
+
|
|
107
|
+
<div class="header-actions">
|
|
108
|
+
<div class="deployment-info">
|
|
109
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.20">Last updated: Aug 7, 2025, 11:50 AM UTC</span>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
115
|
+
<i class="fas fa-moon"></i>
|
|
116
|
+
</button>
|
|
117
|
+
|
|
118
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
119
|
+
<i class="fas fa-bars"></i>
|
|
120
|
+
</button>
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
</header>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<!-- Breadcrumbs -->
|
|
128
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
129
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
130
|
+
</nav>
|
|
131
|
+
|
|
132
|
+
<!-- Main Content -->
|
|
133
|
+
<div class="main-wrapper">
|
|
134
|
+
<!-- Sidebar -->
|
|
135
|
+
<aside class="sidebar">
|
|
136
|
+
<div class="sidebar-header">
|
|
137
|
+
<div class="filter-box">
|
|
138
|
+
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
139
|
+
<i class="fas fa-search filter-icon"></i>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
<nav class="navigation">
|
|
143
|
+
|
|
144
|
+
<div class="nav-section" data-level="0">
|
|
145
|
+
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
146
|
+
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
147
|
+
</a>
|
|
148
|
+
<div class="nav-content">
|
|
149
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
150
|
+
<a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
|
|
151
|
+
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
|
|
152
|
+
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
|
|
153
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
|
|
154
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
|
|
155
|
+
<div class="nav-section" data-level="1">
|
|
156
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
157
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
158
|
+
</a>
|
|
159
|
+
<div class="nav-content" id="nav-guides-1">
|
|
160
|
+
<a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
|
|
161
|
+
<a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="ph ph-check-circle" style="color: #059669;"></i> Authentication Guide</a>
|
|
162
|
+
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
|
|
163
|
+
<a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration Guide</a>
|
|
164
|
+
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
|
|
165
|
+
<a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</a>
|
|
166
|
+
<a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="ph ph-check-circle" style="color: #059669;"></i> Image Modal 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="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
|
|
168
|
+
<a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
|
|
169
|
+
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</a>
|
|
170
|
+
<a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
|
|
171
|
+
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
|
|
172
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
|
|
173
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
|
|
174
|
+
<a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete Guide</a>
|
|
175
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Troubleshooting Guide</a>
|
|
176
|
+
<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="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
|
|
177
|
+
<div class="nav-section" data-level="1">
|
|
178
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
179
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
180
|
+
</a>
|
|
181
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
182
|
+
<a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
|
|
183
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
|
|
184
|
+
<a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to "sasha-publish", including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
|
|
185
|
+
<div class="nav-section" data-level="1">
|
|
186
|
+
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
187
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
188
|
+
</a>
|
|
189
|
+
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
190
|
+
<a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
|
|
191
|
+
<a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
|
|
192
|
+
<a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
|
|
193
|
+
</nav>
|
|
194
|
+
<div class="resize-handle"></div>
|
|
195
|
+
</aside>
|
|
196
|
+
|
|
197
|
+
<!-- Content Area -->
|
|
198
|
+
<main class="content">
|
|
199
|
+
<div class="content-inner">
|
|
200
|
+
<h1>Troubleshooting Guide for @knowcode/doc-builder</h1>
|
|
201
|
+
<h2>Overview</h2>
|
|
202
|
+
<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>
|
|
203
|
+
<h2>NPX Cache Issues</h2>
|
|
204
|
+
<h3>Problem</h3>
|
|
205
|
+
<p>The most common issue users face is npx caching an older version of doc-builder.</p>
|
|
206
|
+
<p><strong>Symptoms:</strong></p>
|
|
207
|
+
<ul>
|
|
208
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
|
|
209
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> New features aren't available despite updating</li>
|
|
210
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Bug fixes don't appear to be working</li>
|
|
211
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Version shown doesn't match npm registry</li>
|
|
212
|
+
</ul>
|
|
213
|
+
<p><strong>Example:</strong></p>
|
|
214
|
+
<pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
|
|
215
|
+
1.4.11 # Old version!
|
|
216
|
+
|
|
217
|
+
# But npm shows:
|
|
218
|
+
$ npm view @knowcode/doc-builder version
|
|
219
|
+
1.4.22 # Latest version
|
|
220
|
+
</code></pre>
|
|
221
|
+
<h3>Solution</h3>
|
|
222
|
+
<pre><code class="language-bash"># Method 1: Clear the npx cache
|
|
223
|
+
npx clear-npx-cache
|
|
224
|
+
|
|
225
|
+
# Method 2: Force the latest version
|
|
226
|
+
npx @knowcode/doc-builder@latest
|
|
227
|
+
|
|
228
|
+
# Method 3: Specify exact version
|
|
229
|
+
npx @knowcode/doc-builder@1.4.22
|
|
230
|
+
</code></pre>
|
|
231
|
+
<h3>Why This Happens</h3>
|
|
232
|
+
<div class="mermaid-wrapper">
|
|
233
|
+
<div class="mermaid">graph TD
|
|
234
|
+
A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
|
|
235
|
+
B -->|Yes| C[Use cached version]
|
|
236
|
+
B -->|No| D[Download from npm]
|
|
237
|
+
C --> E[May be outdated!]
|
|
238
|
+
D --> F[Latest version]
|
|
239
|
+
|
|
240
|
+
style C fill:#ffcdd2
|
|
241
|
+
style E fill:#ffcdd2
|
|
242
|
+
style F fill:#c8e6c9</div>
|
|
243
|
+
</div>
|
|
244
|
+
<p>NPX caches packages to improve performance, but this cache doesn't automatically update when new versions are published.</p>
|
|
245
|
+
<h3>Prevention</h3>
|
|
246
|
+
<ol>
|
|
247
|
+
<li><p><strong>Always use @latest for current version:</strong></p>
|
|
248
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
249
|
+
</code></pre>
|
|
250
|
+
</li>
|
|
251
|
+
<li><p><strong>For development, install globally:</strong></p>
|
|
252
|
+
<pre><code class="language-bash">npm install -g @knowcode/doc-builder
|
|
253
|
+
doc-builder deploy
|
|
254
|
+
</code></pre>
|
|
255
|
+
</li>
|
|
256
|
+
<li><p><strong>For projects, install as dev dependency:</strong></p>
|
|
257
|
+
<pre><code class="language-bash">npm install --save-dev @knowcode/doc-builder
|
|
258
|
+
npx doc-builder deploy # Uses local version
|
|
259
|
+
</code></pre>
|
|
260
|
+
</li>
|
|
261
|
+
</ol>
|
|
262
|
+
<h2>Build Issues</h2>
|
|
263
|
+
<h3>No Markdown Files Found</h3>
|
|
264
|
+
<p><strong>Error:</strong> <code>No markdown files found in docs directory</code></p>
|
|
265
|
+
<p><strong>Solutions:</strong></p>
|
|
266
|
+
<ol>
|
|
267
|
+
<li><p><strong>Check directory structure:</strong></p>
|
|
268
|
+
<pre><code class="language-bash">ls -la docs/
|
|
269
|
+
# Should show .md files
|
|
270
|
+
</code></pre>
|
|
271
|
+
</li>
|
|
272
|
+
<li><p><strong>Ensure correct file extensions:</strong></p>
|
|
273
|
+
<ul>
|
|
274
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
|
|
275
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
|
|
276
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
|
|
277
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
|
|
278
|
+
</ul>
|
|
279
|
+
</li>
|
|
280
|
+
<li><p><strong>Use custom input directory:</strong></p>
|
|
281
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build --input my-docs
|
|
282
|
+
</code></pre>
|
|
283
|
+
</li>
|
|
284
|
+
</ol>
|
|
285
|
+
<h3>Build Output Missing</h3>
|
|
286
|
+
<p><strong>Problem:</strong> HTML files not generated</p>
|
|
287
|
+
<p><strong>Check:</strong></p>
|
|
288
|
+
<ol>
|
|
289
|
+
<li>Look in <code>html/</code> directory (default output)</li>
|
|
290
|
+
<li>Check for build errors in console</li>
|
|
291
|
+
<li>Verify markdown files are valid</li>
|
|
292
|
+
</ol>
|
|
293
|
+
<p><strong>Solution:</strong></p>
|
|
294
|
+
<pre><code class="language-bash"># Clean build
|
|
295
|
+
rm -rf html/
|
|
296
|
+
npx @knowcode/doc-builder@latest build
|
|
297
|
+
|
|
298
|
+
# Check output
|
|
299
|
+
ls -la html/
|
|
300
|
+
</code></pre>
|
|
301
|
+
<h2>Deployment Issues</h2>
|
|
302
|
+
<h3>Vercel CLI Not Found</h3>
|
|
303
|
+
<p><strong>Error:</strong> <code>Vercel CLI not found!</code></p>
|
|
304
|
+
<p><strong>Solution:</strong></p>
|
|
305
|
+
<pre><code class="language-bash"># Install Vercel CLI globally
|
|
306
|
+
npm install -g vercel
|
|
307
|
+
|
|
308
|
+
# Verify installation
|
|
309
|
+
vercel --version
|
|
310
|
+
|
|
311
|
+
# Then retry deployment
|
|
312
|
+
npx @knowcode/doc-builder@latest deploy
|
|
313
|
+
</code></pre>
|
|
314
|
+
<h3>Deployment Fails</h3>
|
|
315
|
+
<p><strong>Common causes:</strong></p>
|
|
316
|
+
<ol>
|
|
317
|
+
<li><p><strong>Not Logged Into Vercel</strong></p>
|
|
318
|
+
<pre><code class="language-bash"># Login to Vercel first
|
|
319
|
+
vercel login
|
|
320
|
+
</code></pre>
|
|
321
|
+
</li>
|
|
322
|
+
<li><p><strong>Build Not Complete</strong></p>
|
|
323
|
+
<pre><code class="language-bash"># Build before deploy
|
|
324
|
+
npx @knowcode/doc-builder@latest build
|
|
325
|
+
npx @knowcode/doc-builder@latest deploy
|
|
326
|
+
</code></pre>
|
|
327
|
+
</li>
|
|
328
|
+
<li><p><strong>Project Name Already Taken</strong></p>
|
|
329
|
+
<ul>
|
|
330
|
+
<li>Choose a different project name</li>
|
|
331
|
+
<li>Or delete the existing project in Vercel dashboard</li>
|
|
332
|
+
</ul>
|
|
333
|
+
</li>
|
|
334
|
+
</ol>
|
|
335
|
+
<h3>Wrong Production URL Displayed</h3>
|
|
336
|
+
<p><strong>Problem:</strong> Deployment shows incorrect URL</p>
|
|
337
|
+
<p><strong>Solution 1:</strong> Update to latest version</p>
|
|
338
|
+
<pre><code class="language-bash"># Clear cache and update
|
|
339
|
+
npx clear-npx-cache
|
|
340
|
+
npx @knowcode/doc-builder@latest deploy
|
|
341
|
+
</code></pre>
|
|
342
|
+
<p><strong>Solution 2:</strong> Set custom URL</p>
|
|
343
|
+
<pre><code class="language-bash"># Set your actual production URL
|
|
344
|
+
npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
|
|
345
|
+
</code></pre>
|
|
346
|
+
<h2>Configuration Issues</h2>
|
|
347
|
+
<h3>Config File Not Loading</h3>
|
|
348
|
+
<p><strong>Symptoms:</strong></p>
|
|
349
|
+
<ul>
|
|
350
|
+
<li>Default settings used instead of custom config</li>
|
|
351
|
+
<li>Site name shows "Documentation"</li>
|
|
352
|
+
</ul>
|
|
353
|
+
<p><strong>Solutions:</strong></p>
|
|
354
|
+
<ol>
|
|
355
|
+
<li><p><strong>Check file name:</strong></p>
|
|
356
|
+
<ul>
|
|
357
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
|
|
358
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
|
|
359
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
|
|
360
|
+
</ul>
|
|
361
|
+
</li>
|
|
362
|
+
<li><p><strong>Verify export format:</strong></p>
|
|
363
|
+
<pre><code class="language-javascript">// Correct
|
|
364
|
+
module.exports = {
|
|
365
|
+
siteName: 'My Docs'
|
|
366
|
+
};
|
|
367
|
+
|
|
368
|
+
// Wrong
|
|
369
|
+
export default {
|
|
370
|
+
siteName: 'My Docs'
|
|
371
|
+
};
|
|
372
|
+
</code></pre>
|
|
373
|
+
</li>
|
|
374
|
+
<li><p><strong>Use explicit config path:</strong></p>
|
|
375
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build --config ./my-config.js
|
|
376
|
+
</code></pre>
|
|
377
|
+
</li>
|
|
378
|
+
</ol>
|
|
379
|
+
<h2>Authentication Issues</h2>
|
|
380
|
+
<h3>Login Page Not Working</h3>
|
|
381
|
+
<p><strong>Check:</strong></p>
|
|
382
|
+
<ol>
|
|
383
|
+
<li>Authentication enabled in config</li>
|
|
384
|
+
<li>Credentials match exactly (case-sensitive)</li>
|
|
385
|
+
<li>Cookies enabled in browser</li>
|
|
386
|
+
</ol>
|
|
387
|
+
<p><strong>Debug:</strong></p>
|
|
388
|
+
<pre><code class="language-javascript">// doc-builder.config.js
|
|
389
|
+
module.exports = {
|
|
390
|
+
features: {
|
|
391
|
+
authentication: true // Must be true
|
|
392
|
+
},
|
|
393
|
+
auth: {
|
|
394
|
+
username: 'admin', // Case sensitive!
|
|
395
|
+
password: 'secret' // Case sensitive!
|
|
396
|
+
}
|
|
397
|
+
};
|
|
398
|
+
</code></pre>
|
|
399
|
+
<h2>Styling Issues</h2>
|
|
400
|
+
<h3>CSS Not Loading</h3>
|
|
401
|
+
<p><strong>Symptoms:</strong></p>
|
|
402
|
+
<ul>
|
|
403
|
+
<li>Plain HTML without styling</li>
|
|
404
|
+
<li>404 errors for CSS files</li>
|
|
405
|
+
</ul>
|
|
406
|
+
<p><strong>Fixed in:</strong> v1.2.0+</p>
|
|
407
|
+
<p><strong>Solutions:</strong></p>
|
|
408
|
+
<ol>
|
|
409
|
+
<li>Update to latest version</li>
|
|
410
|
+
<li>Check browser console for 404 errors</li>
|
|
411
|
+
<li>Verify <code>html/css/</code> directory exists after build</li>
|
|
412
|
+
</ol>
|
|
413
|
+
<h3>Dark Mode Not Working</h3>
|
|
414
|
+
<p><strong>Check:</strong></p>
|
|
415
|
+
<ol>
|
|
416
|
+
<li>Feature enabled in config</li>
|
|
417
|
+
<li>Browser supports CSS variables</li>
|
|
418
|
+
<li>No conflicting styles</li>
|
|
419
|
+
</ol>
|
|
420
|
+
<h2>Development Server Issues</h2>
|
|
421
|
+
<h3>Port Already in Use</h3>
|
|
422
|
+
<p><strong>Error:</strong> <code>Port 3000 is already in use</code></p>
|
|
423
|
+
<p><strong>Solutions:</strong></p>
|
|
424
|
+
<pre><code class="language-bash"># Use different port
|
|
425
|
+
npx @knowcode/doc-builder@latest dev --port 8080
|
|
426
|
+
|
|
427
|
+
# Find process using port
|
|
428
|
+
lsof -i :3000 # macOS/Linux
|
|
429
|
+
netstat -ano | findstr :3000 # Windows
|
|
430
|
+
</code></pre>
|
|
431
|
+
<h3>Hot Reload Not Working</h3>
|
|
432
|
+
<p><strong>Common causes:</strong></p>
|
|
433
|
+
<ol>
|
|
434
|
+
<li>File system events not supported</li>
|
|
435
|
+
<li>Saving files outside watched directory</li>
|
|
436
|
+
<li>Browser cache</li>
|
|
437
|
+
</ol>
|
|
438
|
+
<p><strong>Solutions:</strong></p>
|
|
439
|
+
<ul>
|
|
440
|
+
<li>Hard refresh browser (Ctrl/Cmd + Shift + R)</li>
|
|
441
|
+
<li>Check that files are in <code>docs/</code> directory</li>
|
|
442
|
+
<li>Restart dev server</li>
|
|
443
|
+
</ul>
|
|
444
|
+
<h2>Platform-Specific Issues</h2>
|
|
445
|
+
<h3>Windows Path Issues</h3>
|
|
446
|
+
<p><strong>Problem:</strong> Paths with backslashes cause errors</p>
|
|
447
|
+
<p><strong>Solution:</strong> Use forward slashes or escape backslashes:</p>
|
|
448
|
+
<pre><code class="language-javascript">// Bad
|
|
449
|
+
docsDir: 'C:\Users\me\docs'
|
|
450
|
+
|
|
451
|
+
// Good
|
|
452
|
+
docsDir: 'C:/Users/me/docs'
|
|
453
|
+
// Or
|
|
454
|
+
docsDir: 'C:\\Users\\me\\docs'
|
|
455
|
+
</code></pre>
|
|
456
|
+
<h3>macOS Permission Issues</h3>
|
|
457
|
+
<p><strong>Error:</strong> <code>EACCES: permission denied</code></p>
|
|
458
|
+
<p><strong>Solutions:</strong></p>
|
|
459
|
+
<ol>
|
|
460
|
+
<li>Don't use sudo with npm/npx</li>
|
|
461
|
+
<li>Fix npm permissions:<pre><code class="language-bash">mkdir ~/.npm-global
|
|
462
|
+
npm config set prefix '~/.npm-global'
|
|
463
|
+
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.zshrc
|
|
464
|
+
source ~/.zshrc
|
|
465
|
+
</code></pre>
|
|
466
|
+
</li>
|
|
467
|
+
</ol>
|
|
468
|
+
<h2>Getting Help</h2>
|
|
469
|
+
<h3>Debug Information</h3>
|
|
470
|
+
<p>When reporting issues, include:</p>
|
|
471
|
+
<ol>
|
|
472
|
+
<li><p><strong>Version information:</strong></p>
|
|
473
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest --version
|
|
474
|
+
node --version
|
|
475
|
+
npm --version
|
|
476
|
+
</code></pre>
|
|
477
|
+
</li>
|
|
478
|
+
<li><p><strong>Error messages:</strong> Full error output</p>
|
|
479
|
+
</li>
|
|
480
|
+
<li><p><strong>Configuration:</strong> Your <code>doc-builder.config.js</code> (remove passwords)</p>
|
|
481
|
+
</li>
|
|
482
|
+
<li><p><strong>Directory structure:</strong></p>
|
|
483
|
+
<pre><code class="language-bash">tree -L 2 # or ls -la
|
|
484
|
+
</code></pre>
|
|
485
|
+
</li>
|
|
486
|
+
</ol>
|
|
487
|
+
<h3>Support Channels</h3>
|
|
488
|
+
<ol>
|
|
489
|
+
<li><strong>GitHub Issues:</strong> Report bugs and feature requests</li>
|
|
490
|
+
<li><strong>npm Page:</strong> Check for updates and documentation</li>
|
|
491
|
+
<li><strong>This Guide:</strong> Reference for common problems</li>
|
|
492
|
+
</ol>
|
|
493
|
+
<h2>Quick Reference</h2>
|
|
494
|
+
<table>
|
|
495
|
+
<thead>
|
|
496
|
+
<tr>
|
|
497
|
+
<th>Problem</th>
|
|
498
|
+
<th>Solution</th>
|
|
499
|
+
</tr>
|
|
500
|
+
</thead>
|
|
501
|
+
<tbody><tr>
|
|
502
|
+
<td>Old version running</td>
|
|
503
|
+
<td><code>npx clear-npx-cache</code></td>
|
|
504
|
+
</tr>
|
|
505
|
+
<tr>
|
|
506
|
+
<td>Vercel deploy fails</td>
|
|
507
|
+
<td><code>vercel login</code> then retry</td>
|
|
508
|
+
</tr>
|
|
509
|
+
<tr>
|
|
510
|
+
<td>No markdown found</td>
|
|
511
|
+
<td>Check <code>docs/</code> directory exists</td>
|
|
512
|
+
</tr>
|
|
513
|
+
<tr>
|
|
514
|
+
<td>CSS not loading</td>
|
|
515
|
+
<td>Update to latest version</td>
|
|
516
|
+
</tr>
|
|
517
|
+
<tr>
|
|
518
|
+
<td>Port in use</td>
|
|
519
|
+
<td><code>--port 8080</code></td>
|
|
520
|
+
</tr>
|
|
521
|
+
<tr>
|
|
522
|
+
<td>Config not loading</td>
|
|
523
|
+
<td>Check filename and format</td>
|
|
524
|
+
</tr>
|
|
525
|
+
<tr>
|
|
526
|
+
<td>404 after deploy</td>
|
|
527
|
+
<td>Check Deployment Protection settings</td>
|
|
528
|
+
</tr>
|
|
529
|
+
</tbody></table>
|
|
530
|
+
<hr>
|
|
531
|
+
<h2>Document History</h2>
|
|
532
|
+
<table>
|
|
533
|
+
<thead>
|
|
534
|
+
<tr>
|
|
535
|
+
<th>Date</th>
|
|
536
|
+
<th>Version</th>
|
|
537
|
+
<th>Author</th>
|
|
538
|
+
<th>Changes</th>
|
|
539
|
+
</tr>
|
|
540
|
+
</thead>
|
|
541
|
+
<tbody><tr>
|
|
542
|
+
<td>2025-07-21</td>
|
|
543
|
+
<td>1.0</td>
|
|
544
|
+
<td>System</td>
|
|
545
|
+
<td>Initial troubleshooting guide</td>
|
|
546
|
+
</tr>
|
|
547
|
+
</tbody></table>
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</main>
|
|
551
|
+
</div>
|
|
552
|
+
|
|
553
|
+
<!-- Scripts -->
|
|
554
|
+
<script>
|
|
555
|
+
// Pass configuration to frontend
|
|
556
|
+
window.docBuilderConfig = {
|
|
557
|
+
features: {
|
|
558
|
+
showPdfDownload: true,
|
|
559
|
+
menuDefaultOpen: false,
|
|
560
|
+
mermaidEnhanced: true
|
|
561
|
+
}
|
|
562
|
+
};
|
|
563
|
+
</script>
|
|
564
|
+
<script src="/js/main.js"></script>
|
|
565
|
+
|
|
566
|
+
</body>
|
|
567
|
+
</html>
|