@knowcode/doc-builder 1.9.30 → 1.10.0

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.
Files changed (198) hide show
  1. package/lib/core-builder.js +164 -174
  2. package/lib/emoji-mapper.js +27 -12
  3. package/package.json +12 -2
  4. package/.claude/settings.local.json +0 -56
  5. package/CACHE-BUSTING-GUIDE.md +0 -82
  6. package/CLAUDE.md +0 -86
  7. package/CONTRIBUTING.md +0 -148
  8. package/GITHUB_SETUP.md +0 -203
  9. package/RELEASE-NOTES-1.7.5.md +0 -64
  10. package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
  11. package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
  12. package/add-user-clive.sql +0 -35
  13. package/add-user-lindsay-fixed.sql +0 -85
  14. package/add-user-lindsay.sql +0 -68
  15. package/add-user-pmorgan.sql +0 -35
  16. package/add-user-robbie.sql +0 -35
  17. package/add-wru-users.sql +0 -105
  18. package/debug-login.sql +0 -30
  19. package/doc-builder.config.js +0 -126
  20. package/doc-builder.config.js.backup.1753793768283 +0 -47
  21. package/doc-builder.config.js.backup.1753803964423 +0 -114
  22. package/doc-builder.config.js.backup.1753945707032 +0 -115
  23. package/doc-builder.config.js.backup.1754059241330 +0 -115
  24. package/doc-builder.config.js.backup.1754119567787 +0 -123
  25. package/doc-builder.config.js.backup.1754120048862 +0 -124
  26. package/doc-builder.config.js.backup.1754120529913 +0 -124
  27. package/doc-builder.config.js.backup.1754218469785 +0 -124
  28. package/doc-builder.config.js.backup.1754384764054 +0 -124
  29. package/doc-builder.config.js.backup.1754567425847 +0 -124
  30. package/doc-builder.config.js.backup.1754568137859 +0 -126
  31. package/doc-builder.config.js.backup.1754569388252 +0 -126
  32. package/doc-builder.config.js.backup.1754576694123 +0 -126
  33. package/doc-builder.config.js.backup.1755031374829 +0 -126
  34. package/doc-builder.config.js.backup.1755034500990 +0 -126
  35. package/doc-builder.config.js.backup.1755034809236 +0 -126
  36. package/grant-access.sql +0 -15
  37. package/html/11.png +0 -0
  38. package/html/404.html +0 -115
  39. package/html/README.html +0 -522
  40. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  41. package/html/about-doc-builder.html +0 -491
  42. package/html/auth.js +0 -157
  43. package/html/claude-workflow-guide.html +0 -525
  44. package/html/css/notion-style.css +0 -2502
  45. package/html/documentation-index.html +0 -471
  46. package/html/guides/authentication-default-change.html +0 -370
  47. package/html/guides/authentication-guide.html +0 -509
  48. package/html/guides/cache-control-anti-pattern.html +0 -361
  49. package/html/guides/claude-workflow-guide.html +0 -1074
  50. package/html/guides/configuration-guide.html +0 -472
  51. package/html/guides/document-standards.html +0 -518
  52. package/html/guides/documentation-standards.html +0 -694
  53. package/html/guides/html-embedding-guide.html +0 -461
  54. package/html/guides/image-modal-guide.html +0 -515
  55. package/html/guides/next-steps-walkthrough.html +0 -638
  56. package/html/guides/phosphor-icons-guide.html +0 -584
  57. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  58. package/html/guides/private-directory-authentication.html +0 -541
  59. package/html/guides/public-site-deployment.html +0 -431
  60. package/html/guides/search-engine-verification-guide.html +0 -542
  61. package/html/guides/seo-guide.html +0 -661
  62. package/html/guides/seo-optimization-guide.html +0 -887
  63. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  64. package/html/guides/supabase-auth-integration-plan.html +0 -671
  65. package/html/guides/supabase-auth-setup-guide.html +0 -498
  66. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  67. package/html/guides/troubleshooting-guide.html +0 -633
  68. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  69. package/html/guides/windows-setup-guide.html +0 -859
  70. package/html/image-modal-test.html +0 -318
  71. package/html/index.html +0 -522
  72. package/html/js/auth.js +0 -157
  73. package/html/js/main.js +0 -1754
  74. package/html/launch/README.html +0 -297
  75. package/html/launch/bubble-plugin-specification.html +0 -933
  76. package/html/launch/go-to-market-strategy.html +0 -663
  77. package/html/launch/launch-announcements.html +0 -593
  78. package/html/login.html +0 -102
  79. package/html/logout.html +0 -18
  80. package/html/private/cache-control-anti-pattern.html +0 -429
  81. package/html/private/launch/README.html +0 -371
  82. package/html/private/launch/auth-cleanup-summary.html +0 -361
  83. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  84. package/html/private/launch/go-to-market-strategy.html +0 -737
  85. package/html/private/launch/launch-announcements.html +0 -667
  86. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  87. package/html/private/next-steps-walkthrough.html +0 -679
  88. package/html/private/supabase-auth-implementation-completed.html +0 -454
  89. package/html/private/supabase-auth-implementation-plan.html +0 -594
  90. package/html/private/supabase-auth-integration-plan.html +0 -704
  91. package/html/private/supabase-auth-setup-guide.html +0 -555
  92. package/html/private/test-private-doc.html +0 -302
  93. package/html/private/user-management-tooling.html +0 -601
  94. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  95. package/html/prompts/beautiful-documentation-design.html +0 -784
  96. package/html/prompts/markdown-document-standards.html +0 -422
  97. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  98. package/html/robots.txt +0 -9
  99. package/html/sitemap.xml +0 -357
  100. package/html/test-questions/how-does-it-work%3F.html +0 -294
  101. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  102. package/html/test-questions/what-is-the-purpose.html +0 -293
  103. package/html/test-status.html +0 -281
  104. package/html/vercel-cli-setup-guide.html +0 -495
  105. package/html/vercel-first-time-setup-guide.html +0 -454
  106. package/html/vercel.json +0 -29
  107. package/html-static/11.png +0 -0
  108. package/html-static/404.html +0 -115
  109. package/html-static/README.html +0 -609
  110. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  111. package/html-static/about-doc-builder.html +0 -578
  112. package/html-static/css/notion-style.css +0 -2502
  113. package/html-static/documentation-index.html +0 -558
  114. package/html-static/guides/authentication-default-change.html +0 -457
  115. package/html-static/guides/authentication-guide.html +0 -596
  116. package/html-static/guides/claude-workflow-guide.html +0 -1161
  117. package/html-static/guides/configuration-guide.html +0 -559
  118. package/html-static/guides/documentation-standards.html +0 -781
  119. package/html-static/guides/html-embedding-guide.html +0 -548
  120. package/html-static/guides/image-modal-guide.html +0 -602
  121. package/html-static/guides/phosphor-icons-guide.html +0 -671
  122. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -642
  123. package/html-static/guides/private-directory-authentication.html +0 -628
  124. package/html-static/guides/public-site-deployment.html +0 -518
  125. package/html-static/guides/search-engine-verification-guide.html +0 -629
  126. package/html-static/guides/seo-guide.html +0 -748
  127. package/html-static/guides/seo-optimization-guide.html +0 -974
  128. package/html-static/guides/supabase-authentication-complete-guide.html +0 -953
  129. package/html-static/guides/troubleshooting-guide.html +0 -720
  130. package/html-static/guides/windows-setup-guide.html +0 -946
  131. package/html-static/image-modal-test.html +0 -405
  132. package/html-static/index.html +0 -609
  133. package/html-static/js/main.js +0 -1754
  134. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  135. package/html-static/prompts/beautiful-documentation-design.html +0 -871
  136. package/html-static/prompts/markdown-document-standards.html +0 -509
  137. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -617
  138. package/html-static/robots.txt +0 -5
  139. package/html-static/sitemap.xml +0 -195
  140. package/html-static/test-questions/how-does-it-work%3F.html +0 -381
  141. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -376
  142. package/html-static/test-questions/what-is-the-purpose.html +0 -380
  143. package/html-static/vercel-cli-setup-guide.html +0 -582
  144. package/html-static/vercel-first-time-setup-guide.html +0 -541
  145. package/manage-users.sql +0 -191
  146. package/migrate-to-domain-auth.sql +0 -47
  147. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  148. package/package/CHANGELOG.md +0 -902
  149. package/package/README.md +0 -248
  150. package/package/assets/css/notion-style.css +0 -2211
  151. package/package/assets/js/auth.js +0 -67
  152. package/package/assets/js/main.js +0 -1565
  153. package/package/cli.js +0 -764
  154. package/package/index.js +0 -38
  155. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  156. package/package/lib/builder.js +0 -32
  157. package/package/lib/config.js +0 -278
  158. package/package/lib/core-builder.js +0 -957
  159. package/package/lib/deploy.js +0 -497
  160. package/package/lib/dev-server.js +0 -96
  161. package/package/package.json +0 -34
  162. package/package/scripts/npx-runner.js +0 -27
  163. package/package/scripts/setup.js +0 -56
  164. package/package/test-cache-bust.sh +0 -43
  165. package/public-config.js +0 -22
  166. package/public-html/404.html +0 -115
  167. package/public-html/README.html +0 -149
  168. package/public-html/css/notion-style.css +0 -2036
  169. package/public-html/index.html +0 -149
  170. package/public-html/js/auth.js +0 -67
  171. package/public-html/js/main.js +0 -1485
  172. package/quick-test-commands.md +0 -40
  173. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  174. package/recordings/mh-ls-22jul.txt +0 -2305
  175. package/screenshot.png +0 -0
  176. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  177. package/setup-database-v2.sql +0 -53
  178. package/setup-database.sql +0 -41
  179. package/test-auth-config.js +0 -17
  180. package/test-cache-bust.sh +0 -43
  181. package/test-docs/README.md +0 -39
  182. package/test-html/404.html +0 -115
  183. package/test-html/README.html +0 -172
  184. package/test-html/auth.js +0 -97
  185. package/test-html/css/notion-style.css +0 -2036
  186. package/test-html/index.html +0 -172
  187. package/test-html/js/auth.js +0 -97
  188. package/test-html/js/main.js +0 -1485
  189. package/test-html/login.html +0 -102
  190. package/test-html/logout.html +0 -18
  191. package/update-domain.sql +0 -9
  192. package/user-access-view.sql +0 -49
  193. package/user-management/README.md +0 -301
  194. package/user-management/add-users.sh +0 -776
  195. package/user-management/create-user.js +0 -65
  196. package/user-management/users.txt +0 -15
  197. package/view-all-users.sql +0 -40
  198. package/wru-auth-config.js +0 -17
@@ -1,633 +0,0 @@
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
-
52
- <!-- Hide content until auth check -->
53
- <style>
54
- body {
55
- visibility: hidden;
56
- opacity: 0;
57
- transition: opacity 0.3s ease;
58
- }
59
- body.authenticated {
60
- visibility: visible;
61
- opacity: 1;
62
- }
63
- /* Show login/logout pages immediately */
64
- body.auth-page {
65
- visibility: visible;
66
- opacity: 1;
67
- }
68
- /* Style auth button consistently */
69
- .auth-btn {
70
- background: none;
71
- border: none;
72
- color: var(--text-secondary);
73
- cursor: pointer;
74
- padding: 0.5rem;
75
- border-radius: 0.5rem;
76
- transition: all 0.2s;
77
- font-size: 1.1rem;
78
- }
79
- .auth-btn:hover {
80
- background: var(--bg-secondary);
81
- color: var(--text-primary);
82
- }
83
- </style>
84
-
85
-
86
- <!-- Favicon -->
87
- <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>">
88
-
89
- <script type="application/ld+json">
90
- {
91
- "@context": "https://schema.org",
92
- "@type": "TechArticle",
93
- "headline": "Troubleshooting Guide for @knowcode/doc-builder",
94
- "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.",
95
- "author": {
96
- "@type": "Person",
97
- "name": "Lindsay Smith"
98
- },
99
- "publisher": {
100
- "@type": "Organization",
101
- "name": "Knowcode Ltd",
102
- "url": "https://knowcode.tech"
103
- },
104
- "datePublished": "2025-08-12T21:40:09.399Z",
105
- "dateModified": "2025-08-12T21:40:09.399Z",
106
- "mainEntityOfPage": {
107
- "@type": "WebPage",
108
- "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
109
- },
110
- "breadcrumb": {
111
- "@type": "BreadcrumbList",
112
- "itemListElement": [
113
- {
114
- "@type": "ListItem",
115
- "position": 1,
116
- "name": "@knowcode/doc-builder",
117
- "item": "https://doc-builder-delta.vercel.app"
118
- },
119
- {
120
- "@type": "ListItem",
121
- "position": 2,
122
- "name": "Guides",
123
- "item": "https://doc-builder-delta.vercel.app/guides/"
124
- },
125
- {
126
- "@type": "ListItem",
127
- "position": 3,
128
- "name": "Troubleshooting Guide",
129
- "item": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
130
- }
131
- ]
132
- }
133
- }
134
- </script>
135
- </head>
136
- <body>
137
-
138
- <!-- Header -->
139
- <header class="header">
140
- <div class="header-content">
141
- <a href="/index.html" class="logo">@knowcode/doc-builder</a>
142
-
143
- <div class="header-actions">
144
- <div class="deployment-info">
145
- <span class="deployment-date" title="Built with doc-builder v1.9.29">Last updated: Aug 12, 2025, 09:40 PM UTC</span>
146
- </div>
147
-
148
-
149
- <a href="../../login.html" class="auth-btn" title="Login/Logout">
150
- <i class="fas fa-sign-in-alt"></i>
151
- </a>
152
-
153
-
154
- <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
155
- <i class="fas fa-moon"></i>
156
- </button>
157
-
158
- <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
159
- <i class="fas fa-bars"></i>
160
- </button>
161
- </div>
162
- </div>
163
- </header>
164
-
165
-
166
-
167
-
168
- <!-- Breadcrumbs -->
169
- <nav class="breadcrumbs " id="breadcrumbs" >
170
- <!-- Breadcrumbs will be generated by JavaScript -->
171
- </nav>
172
-
173
- <!-- Main Content -->
174
- <div class="main-wrapper">
175
- <!-- Sidebar -->
176
- <aside class="sidebar">
177
- <div class="sidebar-header">
178
- <div class="filter-box">
179
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
180
- <i class="fas fa-search filter-icon"></i>
181
- </div>
182
- </div>
183
- <nav class="navigation">
184
-
185
- <div class="nav-section" data-level="0">
186
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
187
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
188
- </a>
189
- <div class="nav-content">
190
- <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
191
- <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>
192
- <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>
193
- <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>
194
- <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>
195
- <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>
196
- <div class="nav-section" data-level="1">
197
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
198
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
199
- </a>
200
- <div class="nav-content" id="nav-guides-1">
201
- <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>
202
- <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>
203
- <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>
204
- <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>
205
- <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>
206
- <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>
207
- <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>
208
- <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>
209
- <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>
210
- <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>
211
- <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>
212
- <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>
213
- <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>
214
- <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>
215
- <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>
216
- <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>
217
- <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>
218
- <div class="nav-section private-nav" data-level="1">
219
- <a class="nav-title collapsible" href="#" data-target="nav-private-1" >
220
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-lock"></i> Private
221
- </a>
222
- <div class="nav-content collapsed" id="nav-private-1">
223
- <a href="/private/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="ph ph-check-circle" style="color: #059669;"></i> Cache Control Anti Pattern</a>
224
- <a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we&#039;ve implemented Supabase authentication, let&#039;s walk through testing the implementation and preparing for deployment."><i class="ph ph-check-circle" style="color: #059669;"></i> Next Steps Walkthrough</a>
225
- <a href="/private/supabase-auth-implementation-completed.html" class="nav-item" data-tooltip="This document records the successful implementation of Supabase authentication in @knowcode/doc-builder v1.7.5+."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Completed</a>
226
- <a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Plan</a>
227
- <a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Integration Plan</a>
228
- <a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Setup Guide</a>
229
- <a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="ph ph-file-text"></i> Test Private Doc</a>
230
- <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="ph ph-check-circle" style="color: #059669;"></i> User Management Tooling</a></div></div>
231
- <div class="nav-section private-nav" data-level="2">
232
- <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
233
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-rocket-launch"></i> Launch
234
- </a>
235
- <div class="nav-content collapsed" id="nav-private-launch-2">
236
- <a href="/private/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Overview</a>
237
- <a href="/private/launch/auth-cleanup-summary.html" class="nav-item" data-tooltip="All references to the old client-side authentication system have been removed from @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Auth Cleanup Summary</a>
238
- <a href="/private/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Bubble Plugin Specification</a>
239
- <a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy &amp; Product Launch Plan."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Go To Market Strategy</a>
240
- <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="ph ph-check-circle" style="color: #059669;"></i> Launch Announcements</a>
241
- <a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Deployment Auth Setup</a></div></div>
242
- <div class="nav-section" data-level="1">
243
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
244
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
245
- </a>
246
- <div class="nav-content collapsed" id="nav-prompts-1">
247
- <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>
248
- <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>
249
- <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 &quot;sasha-publish&quot;, including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
250
- <div class="nav-section" data-level="1">
251
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
252
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
253
- </a>
254
- <div class="nav-content collapsed" id="nav-test-questions-1">
255
- <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>
256
- <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>
257
- <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>
258
- </nav>
259
- <div class="resize-handle"></div>
260
- </aside>
261
-
262
- <!-- Content Area -->
263
- <main class="content">
264
- <div class="content-inner">
265
- <h1>Troubleshooting Guide for @knowcode/doc-builder</h1>
266
- <h2>Overview</h2>
267
- <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>
268
- <h2>NPX Cache Issues</h2>
269
- <h3>Problem</h3>
270
- <p>The most common issue users face is npx caching an older version of doc-builder.</p>
271
- <p><strong>Symptoms:</strong></p>
272
- <ul>
273
- <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>
274
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> New features aren&#39;t available despite updating</li>
275
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Bug fixes don&#39;t appear to be working</li>
276
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> Version shown doesn&#39;t match npm registry</li>
277
- </ul>
278
- <p><strong>Example:</strong></p>
279
- <pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
280
- 1.4.11 # Old version!
281
-
282
- # But npm shows:
283
- $ npm view @knowcode/doc-builder version
284
- 1.4.22 # Latest version
285
- </code></pre>
286
- <h3>Solution</h3>
287
- <pre><code class="language-bash"># Method 1: Clear the npx cache
288
- npx clear-npx-cache
289
-
290
- # Method 2: Force the latest version
291
- npx @knowcode/doc-builder@latest
292
-
293
- # Method 3: Specify exact version
294
- npx @knowcode/doc-builder@1.4.22
295
- </code></pre>
296
- <h3>Why This Happens</h3>
297
- <div class="mermaid-wrapper">
298
- <div class="mermaid">graph TD
299
- A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
300
- B -->|Yes| C[Use cached version]
301
- B -->|No| D[Download from npm]
302
- C --> E[May be outdated!]
303
- D --> F[Latest version]
304
-
305
- style C fill:#ffcdd2
306
- style E fill:#ffcdd2
307
- style F fill:#c8e6c9</div>
308
- </div>
309
- <p>NPX caches packages to improve performance, but this cache doesn&#39;t automatically update when new versions are published.</p>
310
- <h3>Prevention</h3>
311
- <ol>
312
- <li><p><strong>Always use @latest for current version:</strong></p>
313
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
314
- </code></pre>
315
- </li>
316
- <li><p><strong>For development, install globally:</strong></p>
317
- <pre><code class="language-bash">npm install -g @knowcode/doc-builder
318
- doc-builder deploy
319
- </code></pre>
320
- </li>
321
- <li><p><strong>For projects, install as dev dependency:</strong></p>
322
- <pre><code class="language-bash">npm install --save-dev @knowcode/doc-builder
323
- npx doc-builder deploy # Uses local version
324
- </code></pre>
325
- </li>
326
- </ol>
327
- <h2>Build Issues</h2>
328
- <h3>No Markdown Files Found</h3>
329
- <p><strong>Error:</strong> <code>No markdown files found in docs directory</code></p>
330
- <p><strong>Solutions:</strong></p>
331
- <ol>
332
- <li><p><strong>Check directory structure:</strong></p>
333
- <pre><code class="language-bash">ls -la docs/
334
- # Should show .md files
335
- </code></pre>
336
- </li>
337
- <li><p><strong>Ensure correct file extensions:</strong></p>
338
- <ul>
339
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
340
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
341
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
342
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
343
- </ul>
344
- </li>
345
- <li><p><strong>Use custom input directory:</strong></p>
346
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest build --input my-docs
347
- </code></pre>
348
- </li>
349
- </ol>
350
- <h3>Build Output Missing</h3>
351
- <p><strong>Problem:</strong> HTML files not generated</p>
352
- <p><strong>Check:</strong></p>
353
- <ol>
354
- <li>Look in <code>html/</code> directory (default output)</li>
355
- <li>Check for build errors in console</li>
356
- <li>Verify markdown files are valid</li>
357
- </ol>
358
- <p><strong>Solution:</strong></p>
359
- <pre><code class="language-bash"># Clean build
360
- rm -rf html/
361
- npx @knowcode/doc-builder@latest build
362
-
363
- # Check output
364
- ls -la html/
365
- </code></pre>
366
- <h2>Deployment Issues</h2>
367
- <h3>Vercel CLI Not Found</h3>
368
- <p><strong>Error:</strong> <code>Vercel CLI not found!</code></p>
369
- <p><strong>Solution:</strong></p>
370
- <pre><code class="language-bash"># Install Vercel CLI globally
371
- npm install -g vercel
372
-
373
- # Verify installation
374
- vercel --version
375
-
376
- # Then retry deployment
377
- npx @knowcode/doc-builder@latest deploy
378
- </code></pre>
379
- <h3>Deployment Fails</h3>
380
- <p><strong>Common causes:</strong></p>
381
- <ol>
382
- <li><p><strong>Not Logged Into Vercel</strong></p>
383
- <pre><code class="language-bash"># Login to Vercel first
384
- vercel login
385
- </code></pre>
386
- </li>
387
- <li><p><strong>Build Not Complete</strong></p>
388
- <pre><code class="language-bash"># Build before deploy
389
- npx @knowcode/doc-builder@latest build
390
- npx @knowcode/doc-builder@latest deploy
391
- </code></pre>
392
- </li>
393
- <li><p><strong>Project Name Already Taken</strong></p>
394
- <ul>
395
- <li>Choose a different project name</li>
396
- <li>Or delete the existing project in Vercel dashboard</li>
397
- </ul>
398
- </li>
399
- </ol>
400
- <h3>Wrong Production URL Displayed</h3>
401
- <p><strong>Problem:</strong> Deployment shows incorrect URL</p>
402
- <p><strong>Solution 1:</strong> Update to latest version</p>
403
- <pre><code class="language-bash"># Clear cache and update
404
- npx clear-npx-cache
405
- npx @knowcode/doc-builder@latest deploy
406
- </code></pre>
407
- <p><strong>Solution 2:</strong> Set custom URL</p>
408
- <pre><code class="language-bash"># Set your actual production URL
409
- npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
410
- </code></pre>
411
- <h2>Configuration Issues</h2>
412
- <h3>Config File Not Loading</h3>
413
- <p><strong>Symptoms:</strong></p>
414
- <ul>
415
- <li>Default settings used instead of custom config</li>
416
- <li>Site name shows &quot;Documentation&quot;</li>
417
- </ul>
418
- <p><strong>Solutions:</strong></p>
419
- <ol>
420
- <li><p><strong>Check file name:</strong></p>
421
- <ul>
422
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
423
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
424
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
425
- </ul>
426
- </li>
427
- <li><p><strong>Verify export format:</strong></p>
428
- <pre><code class="language-javascript">// Correct
429
- module.exports = {
430
- siteName: &#39;My Docs&#39;
431
- };
432
-
433
- // Wrong
434
- export default {
435
- siteName: &#39;My Docs&#39;
436
- };
437
- </code></pre>
438
- </li>
439
- <li><p><strong>Use explicit config path:</strong></p>
440
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest build --config ./my-config.js
441
- </code></pre>
442
- </li>
443
- </ol>
444
- <h2>Authentication Issues</h2>
445
- <h3>Login Page Not Working</h3>
446
- <p><strong>Check:</strong></p>
447
- <ol>
448
- <li>Authentication enabled in config</li>
449
- <li>Credentials match exactly (case-sensitive)</li>
450
- <li>Cookies enabled in browser</li>
451
- </ol>
452
- <p><strong>Debug:</strong></p>
453
- <pre><code class="language-javascript">// doc-builder.config.js
454
- module.exports = {
455
- features: {
456
- authentication: true // Must be true
457
- },
458
- auth: {
459
- username: &#39;admin&#39;, // Case sensitive!
460
- password: &#39;secret&#39; // Case sensitive!
461
- }
462
- };
463
- </code></pre>
464
- <h2>Styling Issues</h2>
465
- <h3>CSS Not Loading</h3>
466
- <p><strong>Symptoms:</strong></p>
467
- <ul>
468
- <li>Plain HTML without styling</li>
469
- <li>404 errors for CSS files</li>
470
- </ul>
471
- <p><strong>Fixed in:</strong> v1.2.0+</p>
472
- <p><strong>Solutions:</strong></p>
473
- <ol>
474
- <li>Update to latest version</li>
475
- <li>Check browser console for 404 errors</li>
476
- <li>Verify <code>html/css/</code> directory exists after build</li>
477
- </ol>
478
- <h3>Dark Mode Not Working</h3>
479
- <p><strong>Check:</strong></p>
480
- <ol>
481
- <li>Feature enabled in config</li>
482
- <li>Browser supports CSS variables</li>
483
- <li>No conflicting styles</li>
484
- </ol>
485
- <h2>Development Server Issues</h2>
486
- <h3>Port Already in Use</h3>
487
- <p><strong>Error:</strong> <code>Port 3000 is already in use</code></p>
488
- <p><strong>Solutions:</strong></p>
489
- <pre><code class="language-bash"># Use different port
490
- npx @knowcode/doc-builder@latest dev --port 8080
491
-
492
- # Find process using port
493
- lsof -i :3000 # macOS/Linux
494
- netstat -ano | findstr :3000 # Windows
495
- </code></pre>
496
- <h3>Hot Reload Not Working</h3>
497
- <p><strong>Common causes:</strong></p>
498
- <ol>
499
- <li>File system events not supported</li>
500
- <li>Saving files outside watched directory</li>
501
- <li>Browser cache</li>
502
- </ol>
503
- <p><strong>Solutions:</strong></p>
504
- <ul>
505
- <li>Hard refresh browser (Ctrl/Cmd + Shift + R)</li>
506
- <li>Check that files are in <code>docs/</code> directory</li>
507
- <li>Restart dev server</li>
508
- </ul>
509
- <h2>Platform-Specific Issues</h2>
510
- <h3>Windows Path Issues</h3>
511
- <p><strong>Problem:</strong> Paths with backslashes cause errors</p>
512
- <p><strong>Solution:</strong> Use forward slashes or escape backslashes:</p>
513
- <pre><code class="language-javascript">// Bad
514
- docsDir: &#39;C:\Users\me\docs&#39;
515
-
516
- // Good
517
- docsDir: &#39;C:/Users/me/docs&#39;
518
- // Or
519
- docsDir: &#39;C:\\Users\\me\\docs&#39;
520
- </code></pre>
521
- <h3>macOS Permission Issues</h3>
522
- <p><strong>Error:</strong> <code>EACCES: permission denied</code></p>
523
- <p><strong>Solutions:</strong></p>
524
- <ol>
525
- <li>Don&#39;t use sudo with npm/npx</li>
526
- <li>Fix npm permissions:<pre><code class="language-bash">mkdir ~/.npm-global
527
- npm config set prefix &#39;~/.npm-global&#39;
528
- echo &#39;export PATH=~/.npm-global/bin:$PATH&#39; &gt;&gt; ~/.zshrc
529
- source ~/.zshrc
530
- </code></pre>
531
- </li>
532
- </ol>
533
- <h2>Getting Help</h2>
534
- <h3>Debug Information</h3>
535
- <p>When reporting issues, include:</p>
536
- <ol>
537
- <li><p><strong>Version information:</strong></p>
538
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest --version
539
- node --version
540
- npm --version
541
- </code></pre>
542
- </li>
543
- <li><p><strong>Error messages:</strong> Full error output</p>
544
- </li>
545
- <li><p><strong>Configuration:</strong> Your <code>doc-builder.config.js</code> (remove passwords)</p>
546
- </li>
547
- <li><p><strong>Directory structure:</strong></p>
548
- <pre><code class="language-bash">tree -L 2 # or ls -la
549
- </code></pre>
550
- </li>
551
- </ol>
552
- <h3>Support Channels</h3>
553
- <ol>
554
- <li><strong>GitHub Issues:</strong> Report bugs and feature requests</li>
555
- <li><strong>npm Page:</strong> Check for updates and documentation</li>
556
- <li><strong>This Guide:</strong> Reference for common problems</li>
557
- </ol>
558
- <h2>Quick Reference</h2>
559
- <table>
560
- <thead>
561
- <tr>
562
- <th>Problem</th>
563
- <th>Solution</th>
564
- </tr>
565
- </thead>
566
- <tbody><tr>
567
- <td>Old version running</td>
568
- <td><code>npx clear-npx-cache</code></td>
569
- </tr>
570
- <tr>
571
- <td>Vercel deploy fails</td>
572
- <td><code>vercel login</code> then retry</td>
573
- </tr>
574
- <tr>
575
- <td>No markdown found</td>
576
- <td>Check <code>docs/</code> directory exists</td>
577
- </tr>
578
- <tr>
579
- <td>CSS not loading</td>
580
- <td>Update to latest version</td>
581
- </tr>
582
- <tr>
583
- <td>Port in use</td>
584
- <td><code>--port 8080</code></td>
585
- </tr>
586
- <tr>
587
- <td>Config not loading</td>
588
- <td>Check filename and format</td>
589
- </tr>
590
- <tr>
591
- <td>404 after deploy</td>
592
- <td>Check Deployment Protection settings</td>
593
- </tr>
594
- </tbody></table>
595
- <hr>
596
- <h2>Document History</h2>
597
- <table>
598
- <thead>
599
- <tr>
600
- <th>Date</th>
601
- <th>Version</th>
602
- <th>Author</th>
603
- <th>Changes</th>
604
- </tr>
605
- </thead>
606
- <tbody><tr>
607
- <td>2025-07-21</td>
608
- <td>1.0</td>
609
- <td>System</td>
610
- <td>Initial troubleshooting guide</td>
611
- </tr>
612
- </tbody></table>
613
-
614
- </div>
615
- </main>
616
- </div>
617
-
618
- <!-- Scripts -->
619
- <script>
620
- // Pass configuration to frontend
621
- window.docBuilderConfig = {
622
- features: {
623
- showPdfDownload: true,
624
- menuDefaultOpen: false,
625
- mermaidEnhanced: true
626
- }
627
- };
628
- </script>
629
- <script src="/js/main.js"></script>
630
- <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
631
- <script src="/js/auth.js"></script>
632
- </body>
633
- </html>