@knowcode/doc-builder 1.8.7 → 1.9.1
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 +27 -0
- package/README.md +2 -0
- package/assets/css/notion-style.css +141 -0
- package/assets/js/main.js +76 -0
- package/html/README.html +41 -149
- package/html/css/notion-style.css +13 -253
- package/html/documentation-index.html +24 -127
- package/html/guides/authentication-default-change.html +15 -130
- package/html/guides/authentication-guide.html +27 -141
- package/html/guides/claude-workflow-guide.html +30 -137
- package/html/guides/documentation-standards.html +19 -133
- package/html/guides/image-modal-guide.html +381 -0
- package/html/guides/phosphor-icons-guide.html +35 -150
- package/html/guides/private-directory-authentication.html +15 -130
- package/html/guides/public-site-deployment.html +15 -130
- package/html/guides/search-engine-verification-guide.html +15 -130
- package/html/guides/seo-guide.html +15 -130
- package/html/guides/seo-optimization-guide.html +46 -159
- package/html/guides/troubleshooting-guide.html +27 -141
- package/html/guides/windows-setup-guide.html +46 -161
- package/html/image-modal-test.html +189 -0
- package/html/index.html +41 -149
- package/html/js/auth.js +39 -118
- package/html/js/main.js +25 -183
- package/html/private/cache-control-anti-pattern.html +20 -135
- package/html/private/launch/README.html +23 -144
- package/html/private/launch/auth-cleanup-summary.html +32 -153
- package/html/private/launch/bubble-plugin-specification.html +15 -136
- package/html/private/launch/go-to-market-strategy.html +17 -138
- package/html/private/launch/launch-announcements.html +31 -151
- package/html/private/launch/vercel-deployment-auth-setup.html +17 -138
- package/html/private/next-steps-walkthrough.html +21 -136
- package/html/private/supabase-auth-implementation-completed.html +29 -143
- package/html/private/supabase-auth-implementation-plan.html +22 -136
- package/html/private/supabase-auth-integration-plan.html +29 -142
- package/html/private/supabase-auth-setup-guide.html +24 -139
- package/html/private/test-private-doc.html +15 -130
- package/html/private/user-management-tooling.html +15 -130
- package/html/prompts/markdown-document-standards.html +288 -0
- package/html/sitemap.xml +56 -44
- package/html/vercel-cli-setup-guide.html +19 -128
- package/html/vercel-first-time-setup-guide.html +16 -125
- package/lib/core-builder.js +1 -0
- package/lib/emoji-mapper.js +25 -0
- package/package/assets/css/notion-style.css +432 -135
- package/package/assets/js/main.js +259 -25
- package/package.json +1 -1
|
@@ -3,41 +3,14 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Troubleshooting Guide for @knowcode/doc-builder</title>
|
|
8
|
-
|
|
9
|
-
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, issues, check">
|
|
11
|
-
<meta name="robots" content="index, follow">
|
|
12
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
|
|
13
|
-
|
|
14
|
-
<!-- Open Graph / Facebook -->
|
|
15
|
-
<meta property="og:type" content="article">
|
|
16
|
-
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html">
|
|
17
|
-
<meta property="og:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
18
|
-
<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.">
|
|
19
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
|
-
<meta property="og:locale" content="en_US">
|
|
22
|
-
|
|
23
|
-
<!-- Twitter Card -->
|
|
24
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
28
|
-
<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.">
|
|
29
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
|
-
|
|
31
|
-
<!-- Custom Meta Tags -->
|
|
32
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
6
|
+
<meta name="description" content="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Troubleshooting Guide for @knowcode/doc-builder - @knowcode/doc-builder</title>
|
|
34
8
|
|
|
35
9
|
<!-- Fonts -->
|
|
36
10
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
37
11
|
|
|
38
12
|
<!-- Icons -->
|
|
39
13
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
40
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
41
14
|
|
|
42
15
|
<!-- Mermaid -->
|
|
43
16
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -45,90 +18,8 @@
|
|
|
45
18
|
<!-- Styles -->
|
|
46
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
47
20
|
|
|
48
|
-
|
|
49
|
-
<!-- Hide content until auth check -->
|
|
50
|
-
<style>
|
|
51
|
-
body {
|
|
52
|
-
visibility: hidden;
|
|
53
|
-
opacity: 0;
|
|
54
|
-
transition: opacity 0.3s ease;
|
|
55
|
-
}
|
|
56
|
-
body.authenticated {
|
|
57
|
-
visibility: visible;
|
|
58
|
-
opacity: 1;
|
|
59
|
-
}
|
|
60
|
-
/* Show login/logout pages immediately */
|
|
61
|
-
body.auth-page {
|
|
62
|
-
visibility: visible;
|
|
63
|
-
opacity: 1;
|
|
64
|
-
}
|
|
65
|
-
/* Style auth button consistently */
|
|
66
|
-
.auth-btn {
|
|
67
|
-
background: none;
|
|
68
|
-
border: none;
|
|
69
|
-
color: var(--text-secondary);
|
|
70
|
-
cursor: pointer;
|
|
71
|
-
padding: 0.5rem;
|
|
72
|
-
border-radius: 0.5rem;
|
|
73
|
-
transition: all 0.2s;
|
|
74
|
-
font-size: 1.1rem;
|
|
75
|
-
}
|
|
76
|
-
.auth-btn:hover {
|
|
77
|
-
background: var(--bg-secondary);
|
|
78
|
-
color: var(--text-primary);
|
|
79
|
-
}
|
|
80
|
-
</style>
|
|
81
|
-
|
|
82
|
-
|
|
83
21
|
<!-- Favicon -->
|
|
84
|
-
<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
|
|
85
|
-
|
|
86
|
-
<script type="application/ld+json">
|
|
87
|
-
{
|
|
88
|
-
"@context": "https://schema.org",
|
|
89
|
-
"@type": "TechArticle",
|
|
90
|
-
"headline": "Troubleshooting Guide for @knowcode/doc-builder",
|
|
91
|
-
"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.",
|
|
92
|
-
"author": {
|
|
93
|
-
"@type": "Person",
|
|
94
|
-
"name": "Lindsay Smith"
|
|
95
|
-
},
|
|
96
|
-
"publisher": {
|
|
97
|
-
"@type": "Organization",
|
|
98
|
-
"name": "Knowcode Ltd",
|
|
99
|
-
"url": "https://knowcode.tech"
|
|
100
|
-
},
|
|
101
|
-
"datePublished": "2025-07-26T16:10:10.624Z",
|
|
102
|
-
"dateModified": "2025-07-26T16:10:10.624Z",
|
|
103
|
-
"mainEntityOfPage": {
|
|
104
|
-
"@type": "WebPage",
|
|
105
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
|
|
106
|
-
},
|
|
107
|
-
"breadcrumb": {
|
|
108
|
-
"@type": "BreadcrumbList",
|
|
109
|
-
"itemListElement": [
|
|
110
|
-
{
|
|
111
|
-
"@type": "ListItem",
|
|
112
|
-
"position": 1,
|
|
113
|
-
"name": "@knowcode/doc-builder",
|
|
114
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
115
|
-
},
|
|
116
|
-
{
|
|
117
|
-
"@type": "ListItem",
|
|
118
|
-
"position": 2,
|
|
119
|
-
"name": "Guides",
|
|
120
|
-
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
"@type": "ListItem",
|
|
124
|
-
"position": 3,
|
|
125
|
-
"name": "Troubleshooting Guide",
|
|
126
|
-
"item": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
|
|
127
|
-
}
|
|
128
|
-
]
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
</script>
|
|
22
|
+
<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>">
|
|
132
23
|
</head>
|
|
133
24
|
<body>
|
|
134
25
|
<!-- Header -->
|
|
@@ -138,14 +29,10 @@
|
|
|
138
29
|
|
|
139
30
|
<div class="header-actions">
|
|
140
31
|
<div class="deployment-info">
|
|
141
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
142
33
|
</div>
|
|
143
34
|
|
|
144
35
|
|
|
145
|
-
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
-
</a>
|
|
148
|
-
|
|
149
36
|
|
|
150
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
151
38
|
<i class="fas fa-moon"></i>
|
|
@@ -193,6 +80,7 @@
|
|
|
193
80
|
<div class="nav-content" >
|
|
194
81
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
195
82
|
<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>
|
|
83
|
+
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
|
|
196
84
|
<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>
|
|
197
85
|
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
198
86
|
<div class="nav-section" data-level="1">
|
|
@@ -204,6 +92,7 @@
|
|
|
204
92
|
<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="fas fa-file-alt"></i> Authentication Guide</a>
|
|
205
93
|
<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>
|
|
206
94
|
<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>
|
|
95
|
+
<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="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
207
96
|
<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>
|
|
208
97
|
<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="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
209
98
|
<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="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
@@ -212,7 +101,7 @@
|
|
|
212
101
|
<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>
|
|
213
102
|
<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>
|
|
214
103
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
215
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
216
105
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
217
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
218
107
|
</a>
|
|
@@ -225,7 +114,7 @@
|
|
|
225
114
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
226
115
|
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
227
116
|
<a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
228
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
229
118
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
230
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
231
120
|
</a>
|
|
@@ -236,6 +125,12 @@
|
|
|
236
125
|
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
237
126
|
<a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a>
|
|
238
127
|
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
128
|
+
<div class="nav-section" data-level="1">
|
|
129
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
130
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
|
|
131
|
+
</a>
|
|
132
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
133
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
|
|
239
134
|
</nav>
|
|
240
135
|
<div class="resize-handle"></div>
|
|
241
136
|
</aside>
|
|
@@ -251,10 +146,10 @@
|
|
|
251
146
|
<p>The most common issue users face is npx caching an older version of doc-builder.</p>
|
|
252
147
|
<p><strong>Symptoms:</strong></p>
|
|
253
148
|
<ul>
|
|
254
|
-
<li
|
|
255
|
-
<li
|
|
256
|
-
<li
|
|
257
|
-
<li
|
|
149
|
+
<li>❌ Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
|
|
150
|
+
<li>❌ New features aren't available despite updating</li>
|
|
151
|
+
<li>❌ Bug fixes don't appear to be working</li>
|
|
152
|
+
<li>❌ Version shown doesn't match npm registry</li>
|
|
258
153
|
</ul>
|
|
259
154
|
<p><strong>Example:</strong></p>
|
|
260
155
|
<pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
|
|
@@ -276,6 +171,7 @@ npx @knowcode/doc-builder@1.4.22
|
|
|
276
171
|
</code></pre>
|
|
277
172
|
<h3>Why This Happens</h3>
|
|
278
173
|
<div class="mermaid-wrapper">
|
|
174
|
+
<div class="mermaid-title">Diagram</div>
|
|
279
175
|
<div class="mermaid">graph TD
|
|
280
176
|
A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
|
|
281
177
|
B -->|Yes| C[Use cached version]
|
|
@@ -317,10 +213,10 @@ npx doc-builder deploy # Uses local version
|
|
|
317
213
|
</li>
|
|
318
214
|
<li><p><strong>Ensure correct file extensions:</strong></p>
|
|
319
215
|
<ul>
|
|
320
|
-
<li
|
|
321
|
-
<li
|
|
322
|
-
<li
|
|
323
|
-
<li
|
|
216
|
+
<li>✅ <code>README.md</code></li>
|
|
217
|
+
<li>✅ <code>guide.md</code></li>
|
|
218
|
+
<li>❌ <code>README.txt</code></li>
|
|
219
|
+
<li>❌ <code>guide.markdown</code></li>
|
|
324
220
|
</ul>
|
|
325
221
|
</li>
|
|
326
222
|
<li><p><strong>Use custom input directory:</strong></p>
|
|
@@ -400,9 +296,9 @@ npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
|
|
|
400
296
|
<ol>
|
|
401
297
|
<li><p><strong>Check file name:</strong></p>
|
|
402
298
|
<ul>
|
|
403
|
-
<li
|
|
404
|
-
<li
|
|
405
|
-
<li
|
|
299
|
+
<li>✅ <code>doc-builder.config.js</code></li>
|
|
300
|
+
<li>❌ <code>docbuilder.config.js</code></li>
|
|
301
|
+
<li>❌ <code>doc-builder-config.js</code></li>
|
|
406
302
|
</ul>
|
|
407
303
|
</li>
|
|
408
304
|
<li><p><strong>Verify export format:</strong></p>
|
|
@@ -597,17 +493,7 @@ npm --version
|
|
|
597
493
|
</div>
|
|
598
494
|
|
|
599
495
|
<!-- Scripts -->
|
|
600
|
-
<script>
|
|
601
|
-
// Pass configuration to frontend
|
|
602
|
-
window.docBuilderConfig = {
|
|
603
|
-
features: {
|
|
604
|
-
showPdfDownload: true,
|
|
605
|
-
menuDefaultOpen: false
|
|
606
|
-
}
|
|
607
|
-
};
|
|
608
|
-
</script>
|
|
609
496
|
<script src="/js/main.js"></script>
|
|
610
|
-
|
|
611
|
-
<script src="/js/auth.js"></script>
|
|
497
|
+
|
|
612
498
|
</body>
|
|
613
499
|
</html>
|