@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
package/html-static/guides/troubleshooting-guide.html DELETED
@@ -1,720 +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
- <!-- Blue theme and white background overrides for static output -->
51
- <style>
52
- /* Override green colors with blue */
53
- :root {
54
- --primary: #2563eb;
55
- --primary-dark: #1d4ed8;
56
- --primary-light: #dbeafe;
57
- --accent: #3b82f6;
58
- --color-accent-green: #2563eb;
59
- --color-accent-emerald: #3b82f6;
60
-
61
- /* White backgrounds for cleaner appearance */
62
- --color-bg-secondary: #FFFFFF;
63
- --color-bg-tertiary: #FAFAFA;
64
- --color-bg-hover: #F8F9FA;
65
- }
66
-
67
- /* Override green status colors with blue variants */
68
- .nav-item.active {
69
- background-color: #dbeafe !important;
70
- color: #1d4ed8 !important;
71
- }
72
-
73
- .nav-item:hover {
74
- background-color: #eff6ff !important;
75
- }
76
-
77
- /* Override complete/success icons to blue */
78
- .ph-check-circle[style*="color: #059669"] {
79
- color: #2563eb !important;
80
- }
81
-
82
- /* Override README/home icon color */
83
- .ph-house[style*="color: #059669"] {
84
- color: #2563eb !important;
85
- }
86
-
87
- /* Override links */
88
- a {
89
- color: #2563eb;
90
- }
91
-
92
- a:hover {
93
- color: #1d4ed8;
94
- }
95
-
96
- /* Override buttons and interactive elements */
97
- .theme-toggle:hover,
98
- .menu-toggle:hover {
99
- background-color: #dbeafe;
100
- color: #1d4ed8;
101
- }
102
-
103
- /* Override nav title hover */
104
- .nav-title:hover {
105
- background-color: #eff6ff;
106
- }
107
-
108
- /* White backgrounds for sidebar and navigation */
109
- body:not(.dark-mode) .sidebar {
110
- background: #FFFFFF !important;
111
- background-color: #FFFFFF !important;
112
- border-right: 1px solid #E5E7EB !important;
113
- }
114
-
115
- body:not(.dark-mode) .nav-section {
116
- background: #FFFFFF !important;
117
- background-color: #FFFFFF !important;
118
- }
119
-
120
- body:not(.dark-mode) .nav-content {
121
- background: #FFFFFF !important;
122
- background-color: #FFFFFF !important;
123
- }
124
-
125
- body:not(.dark-mode) .navigation {
126
- background: #FFFFFF !important;
127
- background-color: #FFFFFF !important;
128
- }
129
-
130
- /* Subtle separation for nav sections */
131
- body:not(.dark-mode) .nav-section + .nav-section {
132
- border-top: 1px solid #F3F4F6;
133
- }
134
-
135
- /* Adjust hover states for white backgrounds */
136
- body:not(.dark-mode) .nav-item:hover {
137
- background-color: #F8F9FA !important;
138
- }
139
-
140
- body:not(.dark-mode) .nav-title.collapsible:hover {
141
- background-color: #F8F9FA !important;
142
- }
143
-
144
- /* Header stays white (already is) but ensure consistency */
145
- body:not(.dark-mode) .header {
146
- background: #FFFFFF !important;
147
- background-color: #FFFFFF !important;
148
- border-bottom: 1px solid #E5E7EB !important;
149
- }
150
-
151
- /* Ensure search box looks good on white */
152
- body:not(.dark-mode) .filter-input,
153
- body:not(.dark-mode) .sidebar-search {
154
- background: #F8F9FA !important;
155
- background-color: #F8F9FA !important;
156
- border: 1px solid #E5E7EB !important;
157
- }
158
-
159
- body:not(.dark-mode) .filter-input:focus,
160
- body:not(.dark-mode) .sidebar-search:focus {
161
- background: #FFFFFF !important;
162
- background-color: #FFFFFF !important;
163
- border-color: #2563eb !important;
164
- }
165
-
166
- /* Override breadcrumbs */
167
- .breadcrumbs a {
168
- color: #2563eb;
169
- }
170
-
171
- .breadcrumbs a:hover {
172
- color: #1d4ed8;
173
- background-color: #dbeafe;
174
- }
175
-
176
- /* Override filter icon */
177
- .filter-icon {
178
- color: #2563eb;
179
- }
180
-
181
- /* Override deployment info on hover */
182
- .deployment-date:hover {
183
- color: #2563eb;
184
- }
185
-
186
- /* Dark mode adjustments */
187
- body.dark-mode {
188
- --primary: #3b82f6;
189
- --primary-dark: #2563eb;
190
- --primary-light: #1e3a8a;
191
- --accent: #60a5fa;
192
- }
193
-
194
- body.dark-mode .nav-item.active {
195
- background-color: rgba(59, 130, 246, 0.1) !important;
196
- color: #60a5fa !important;
197
- }
198
-
199
- body.dark-mode .nav-item:hover {
200
- background-color: rgba(59, 130, 246, 0.05) !important;
201
- }
202
-
203
- body.dark-mode a {
204
- color: #60a5fa;
205
- }
206
-
207
- body.dark-mode a:hover {
208
- color: #93bbfc;
209
- }
210
- </style>
211
-
212
-
213
-
214
-
215
- <!-- Favicon -->
216
- <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>">
217
-
218
- <script type="application/ld+json">
219
- {
220
- "@context": "https://schema.org",
221
- "@type": "TechArticle",
222
- "headline": "Troubleshooting Guide for @knowcode/doc-builder",
223
- "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.",
224
- "author": {
225
- "@type": "Person",
226
- "name": "Lindsay Smith"
227
- },
228
- "publisher": {
229
- "@type": "Organization",
230
- "name": "Knowcode Ltd",
231
- "url": "https://knowcode.tech"
232
- },
233
- "datePublished": "2025-08-12T21:40:09.535Z",
234
- "dateModified": "2025-08-12T21:40:09.535Z",
235
- "mainEntityOfPage": {
236
- "@type": "WebPage",
237
- "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
238
- },
239
- "breadcrumb": {
240
- "@type": "BreadcrumbList",
241
- "itemListElement": [
242
- {
243
- "@type": "ListItem",
244
- "position": 1,
245
- "name": "@knowcode/doc-builder",
246
- "item": "https://doc-builder-delta.vercel.app"
247
- },
248
- {
249
- "@type": "ListItem",
250
- "position": 2,
251
- "name": "Guides",
252
- "item": "https://doc-builder-delta.vercel.app/guides/"
253
- },
254
- {
255
- "@type": "ListItem",
256
- "position": 3,
257
- "name": "Troubleshooting Guide",
258
- "item": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
259
- }
260
- ]
261
- }
262
- }
263
- </script>
264
- </head>
265
- <body>
266
-
267
-
268
-
269
-
270
- <!-- Breadcrumbs -->
271
- <nav class="breadcrumbs breadcrumbs-static" id="breadcrumbs" data-build-date="Aug 12, 2025, 09:40 PM UTC" data-doc-builder-version="1.9.29">
272
-
273
- <!-- Pre-rendered breadcrumb content for static builds -->
274
- <div class="breadcrumbs-content breadcrumbs-homepage">
275
- <div class="breadcrumbs-right">
276
- <span class="breadcrumb-date" title="Built with doc-builder v1.9.29">Last updated: Aug 12, 2025, 09:40 PM UTC</span>
277
- <button class="breadcrumb-pdf-btn" onclick="if(typeof exportToPDF !== 'undefined') exportToPDF(); else window.print();" title="Export to PDF" aria-label="Export to PDF">
278
- <i class="fas fa-file-pdf"></i>
279
- </button>
280
- </div>
281
- </div>
282
-
283
- </nav>
284
-
285
- <!-- Main Content -->
286
- <div class="main-wrapper">
287
- <!-- Sidebar -->
288
- <aside class="sidebar">
289
- <div class="sidebar-header">
290
- <div class="filter-box">
291
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
292
- <i class="fas fa-search filter-icon"></i>
293
- </div>
294
- </div>
295
- <nav class="navigation">
296
-
297
- <div class="nav-section" data-level="0">
298
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
299
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
300
- </a>
301
- <div class="nav-content">
302
- <a href="README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
303
- <a href="about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #2563eb;"></i> About Doc Builder</a>
304
- <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>
305
- <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>
306
- <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: #2563eb;"></i> Vercel Cli Setup Guide</a>
307
- <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: #2563eb;"></i> Vercel First Time Setup Guide</a></div></div>
308
- <div class="nav-section" data-level="1">
309
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
310
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
311
- </a>
312
- <div class="nav-content" id="nav-guides-1">
313
- <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>
314
- <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: #2563eb;"></i> Authentication Guide</a>
315
- <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>
316
- <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: #2563eb;"></i> Configuration Guide</a>
317
- <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>
318
- <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: #2563eb;"></i> Html Embedding Guide</a>
319
- <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: #2563eb;"></i> Image Modal Guide</a>
320
- <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>
321
- <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: #2563eb;"></i> Private Directory Authentication</a>
322
- <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: #2563eb;"></i> Private Directory Authentication Troubleshooting</a>
323
- <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: #2563eb;"></i> Public Site Deployment</a>
324
- <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: #2563eb;"></i> Search Engine Verification Guide</a>
325
- <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: #2563eb;"></i> Seo Guide</a>
326
- <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: #2563eb;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
327
- <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: #2563eb;"></i> Supabase Authentication Complete Guide</a>
328
- <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: #2563eb;"></i> Troubleshooting Guide</a>
329
- <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: #2563eb;"></i> Windows Setup Guide</a></div></div>
330
- <div class="nav-section" data-level="1">
331
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
332
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
333
- </a>
334
- <div class="nav-content collapsed" id="nav-prompts-1">
335
- <a href="prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Beautiful Documentation Design</a>
336
- <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>
337
- <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>
338
- <div class="nav-section" data-level="1">
339
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
340
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
341
- </a>
342
- <div class="nav-content collapsed" id="nav-test-questions-1">
343
- <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>
344
- <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>
345
- <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>
346
- </nav>
347
- <div class="resize-handle"></div>
348
- </aside>
349
-
350
- <!-- Content Area -->
351
- <main class="content">
352
- <div class="content-inner">
353
- <h1>Troubleshooting Guide for @knowcode/doc-builder</h1>
354
- <h2>Overview</h2>
355
- <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>
356
- <h2>NPX Cache Issues</h2>
357
- <h3>Problem</h3>
358
- <p>The most common issue users face is npx caching an older version of doc-builder.</p>
359
- <p><strong>Symptoms:</strong></p>
360
- <ul>
361
- <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>
362
- <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>
363
- <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>
364
- <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>
365
- </ul>
366
- <p><strong>Example:</strong></p>
367
- <pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
368
- 1.4.11 # Old version!
369
-
370
- # But npm shows:
371
- $ npm view @knowcode/doc-builder version
372
- 1.4.22 # Latest version
373
- </code></pre>
374
- <h3>Solution</h3>
375
- <pre><code class="language-bash"># Method 1: Clear the npx cache
376
- npx clear-npx-cache
377
-
378
- # Method 2: Force the latest version
379
- npx @knowcode/doc-builder@latest
380
-
381
- # Method 3: Specify exact version
382
- npx @knowcode/doc-builder@1.4.22
383
- </code></pre>
384
- <h3>Why This Happens</h3>
385
- <div class="mermaid-wrapper">
386
- <div class="mermaid">graph TD
387
- A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
388
- B -->|Yes| C[Use cached version]
389
- B -->|No| D[Download from npm]
390
- C --> E[May be outdated!]
391
- D --> F[Latest version]
392
-
393
- style C fill:#ffcdd2
394
- style E fill:#ffcdd2
395
- style F fill:#c8e6c9</div>
396
- </div>
397
- <p>NPX caches packages to improve performance, but this cache doesn&#39;t automatically update when new versions are published.</p>
398
- <h3>Prevention</h3>
399
- <ol>
400
- <li><p><strong>Always use @latest for current version:</strong></p>
401
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
402
- </code></pre>
403
- </li>
404
- <li><p><strong>For development, install globally:</strong></p>
405
- <pre><code class="language-bash">npm install -g @knowcode/doc-builder
406
- doc-builder deploy
407
- </code></pre>
408
- </li>
409
- <li><p><strong>For projects, install as dev dependency:</strong></p>
410
- <pre><code class="language-bash">npm install --save-dev @knowcode/doc-builder
411
- npx doc-builder deploy # Uses local version
412
- </code></pre>
413
- </li>
414
- </ol>
415
- <h2>Build Issues</h2>
416
- <h3>No Markdown Files Found</h3>
417
- <p><strong>Error:</strong> <code>No markdown files found in docs directory</code></p>
418
- <p><strong>Solutions:</strong></p>
419
- <ol>
420
- <li><p><strong>Check directory structure:</strong></p>
421
- <pre><code class="language-bash">ls -la docs/
422
- # Should show .md files
423
- </code></pre>
424
- </li>
425
- <li><p><strong>Ensure correct file extensions:</strong></p>
426
- <ul>
427
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
428
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
429
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
430
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
431
- </ul>
432
- </li>
433
- <li><p><strong>Use custom input directory:</strong></p>
434
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest build --input my-docs
435
- </code></pre>
436
- </li>
437
- </ol>
438
- <h3>Build Output Missing</h3>
439
- <p><strong>Problem:</strong> HTML files not generated</p>
440
- <p><strong>Check:</strong></p>
441
- <ol>
442
- <li>Look in <code>html/</code> directory (default output)</li>
443
- <li>Check for build errors in console</li>
444
- <li>Verify markdown files are valid</li>
445
- </ol>
446
- <p><strong>Solution:</strong></p>
447
- <pre><code class="language-bash"># Clean build
448
- rm -rf html/
449
- npx @knowcode/doc-builder@latest build
450
-
451
- # Check output
452
- ls -la html/
453
- </code></pre>
454
- <h2>Deployment Issues</h2>
455
- <h3>Vercel CLI Not Found</h3>
456
- <p><strong>Error:</strong> <code>Vercel CLI not found!</code></p>
457
- <p><strong>Solution:</strong></p>
458
- <pre><code class="language-bash"># Install Vercel CLI globally
459
- npm install -g vercel
460
-
461
- # Verify installation
462
- vercel --version
463
-
464
- # Then retry deployment
465
- npx @knowcode/doc-builder@latest deploy
466
- </code></pre>
467
- <h3>Deployment Fails</h3>
468
- <p><strong>Common causes:</strong></p>
469
- <ol>
470
- <li><p><strong>Not Logged Into Vercel</strong></p>
471
- <pre><code class="language-bash"># Login to Vercel first
472
- vercel login
473
- </code></pre>
474
- </li>
475
- <li><p><strong>Build Not Complete</strong></p>
476
- <pre><code class="language-bash"># Build before deploy
477
- npx @knowcode/doc-builder@latest build
478
- npx @knowcode/doc-builder@latest deploy
479
- </code></pre>
480
- </li>
481
- <li><p><strong>Project Name Already Taken</strong></p>
482
- <ul>
483
- <li>Choose a different project name</li>
484
- <li>Or delete the existing project in Vercel dashboard</li>
485
- </ul>
486
- </li>
487
- </ol>
488
- <h3>Wrong Production URL Displayed</h3>
489
- <p><strong>Problem:</strong> Deployment shows incorrect URL</p>
490
- <p><strong>Solution 1:</strong> Update to latest version</p>
491
- <pre><code class="language-bash"># Clear cache and update
492
- npx clear-npx-cache
493
- npx @knowcode/doc-builder@latest deploy
494
- </code></pre>
495
- <p><strong>Solution 2:</strong> Set custom URL</p>
496
- <pre><code class="language-bash"># Set your actual production URL
497
- npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
498
- </code></pre>
499
- <h2>Configuration Issues</h2>
500
- <h3>Config File Not Loading</h3>
501
- <p><strong>Symptoms:</strong></p>
502
- <ul>
503
- <li>Default settings used instead of custom config</li>
504
- <li>Site name shows &quot;Documentation&quot;</li>
505
- </ul>
506
- <p><strong>Solutions:</strong></p>
507
- <ol>
508
- <li><p><strong>Check file name:</strong></p>
509
- <ul>
510
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
511
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
512
- <li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
513
- </ul>
514
- </li>
515
- <li><p><strong>Verify export format:</strong></p>
516
- <pre><code class="language-javascript">// Correct
517
- module.exports = {
518
- siteName: &#39;My Docs&#39;
519
- };
520
-
521
- // Wrong
522
- export default {
523
- siteName: &#39;My Docs&#39;
524
- };
525
- </code></pre>
526
- </li>
527
- <li><p><strong>Use explicit config path:</strong></p>
528
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest build --config ./my-config.js
529
- </code></pre>
530
- </li>
531
- </ol>
532
- <h2>Authentication Issues</h2>
533
- <h3>Login Page Not Working</h3>
534
- <p><strong>Check:</strong></p>
535
- <ol>
536
- <li>Authentication enabled in config</li>
537
- <li>Credentials match exactly (case-sensitive)</li>
538
- <li>Cookies enabled in browser</li>
539
- </ol>
540
- <p><strong>Debug:</strong></p>
541
- <pre><code class="language-javascript">// doc-builder.config.js
542
- module.exports = {
543
- features: {
544
- authentication: true // Must be true
545
- },
546
- auth: {
547
- username: &#39;admin&#39;, // Case sensitive!
548
- password: &#39;secret&#39; // Case sensitive!
549
- }
550
- };
551
- </code></pre>
552
- <h2>Styling Issues</h2>
553
- <h3>CSS Not Loading</h3>
554
- <p><strong>Symptoms:</strong></p>
555
- <ul>
556
- <li>Plain HTML without styling</li>
557
- <li>404 errors for CSS files</li>
558
- </ul>
559
- <p><strong>Fixed in:</strong> v1.2.0+</p>
560
- <p><strong>Solutions:</strong></p>
561
- <ol>
562
- <li>Update to latest version</li>
563
- <li>Check browser console for 404 errors</li>
564
- <li>Verify <code>html/css/</code> directory exists after build</li>
565
- </ol>
566
- <h3>Dark Mode Not Working</h3>
567
- <p><strong>Check:</strong></p>
568
- <ol>
569
- <li>Feature enabled in config</li>
570
- <li>Browser supports CSS variables</li>
571
- <li>No conflicting styles</li>
572
- </ol>
573
- <h2>Development Server Issues</h2>
574
- <h3>Port Already in Use</h3>
575
- <p><strong>Error:</strong> <code>Port 3000 is already in use</code></p>
576
- <p><strong>Solutions:</strong></p>
577
- <pre><code class="language-bash"># Use different port
578
- npx @knowcode/doc-builder@latest dev --port 8080
579
-
580
- # Find process using port
581
- lsof -i :3000 # macOS/Linux
582
- netstat -ano | findstr :3000 # Windows
583
- </code></pre>
584
- <h3>Hot Reload Not Working</h3>
585
- <p><strong>Common causes:</strong></p>
586
- <ol>
587
- <li>File system events not supported</li>
588
- <li>Saving files outside watched directory</li>
589
- <li>Browser cache</li>
590
- </ol>
591
- <p><strong>Solutions:</strong></p>
592
- <ul>
593
- <li>Hard refresh browser (Ctrl/Cmd + Shift + R)</li>
594
- <li>Check that files are in <code>docs/</code> directory</li>
595
- <li>Restart dev server</li>
596
- </ul>
597
- <h2>Platform-Specific Issues</h2>
598
- <h3>Windows Path Issues</h3>
599
- <p><strong>Problem:</strong> Paths with backslashes cause errors</p>
600
- <p><strong>Solution:</strong> Use forward slashes or escape backslashes:</p>
601
- <pre><code class="language-javascript">// Bad
602
- docsDir: &#39;C:\Users\me\docs&#39;
603
-
604
- // Good
605
- docsDir: &#39;C:/Users/me/docs&#39;
606
- // Or
607
- docsDir: &#39;C:\\Users\\me\\docs&#39;
608
- </code></pre>
609
- <h3>macOS Permission Issues</h3>
610
- <p><strong>Error:</strong> <code>EACCES: permission denied</code></p>
611
- <p><strong>Solutions:</strong></p>
612
- <ol>
613
- <li>Don&#39;t use sudo with npm/npx</li>
614
- <li>Fix npm permissions:<pre><code class="language-bash">mkdir ~/.npm-global
615
- npm config set prefix &#39;~/.npm-global&#39;
616
- echo &#39;export PATH=~/.npm-global/bin:$PATH&#39; &gt;&gt; ~/.zshrc
617
- source ~/.zshrc
618
- </code></pre>
619
- </li>
620
- </ol>
621
- <h2>Getting Help</h2>
622
- <h3>Debug Information</h3>
623
- <p>When reporting issues, include:</p>
624
- <ol>
625
- <li><p><strong>Version information:</strong></p>
626
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest --version
627
- node --version
628
- npm --version
629
- </code></pre>
630
- </li>
631
- <li><p><strong>Error messages:</strong> Full error output</p>
632
- </li>
633
- <li><p><strong>Configuration:</strong> Your <code>doc-builder.config.js</code> (remove passwords)</p>
634
- </li>
635
- <li><p><strong>Directory structure:</strong></p>
636
- <pre><code class="language-bash">tree -L 2 # or ls -la
637
- </code></pre>
638
- </li>
639
- </ol>
640
- <h3>Support Channels</h3>
641
- <ol>
642
- <li><strong>GitHub Issues:</strong> Report bugs and feature requests</li>
643
- <li><strong>npm Page:</strong> Check for updates and documentation</li>
644
- <li><strong>This Guide:</strong> Reference for common problems</li>
645
- </ol>
646
- <h2>Quick Reference</h2>
647
- <table>
648
- <thead>
649
- <tr>
650
- <th>Problem</th>
651
- <th>Solution</th>
652
- </tr>
653
- </thead>
654
- <tbody><tr>
655
- <td>Old version running</td>
656
- <td><code>npx clear-npx-cache</code></td>
657
- </tr>
658
- <tr>
659
- <td>Vercel deploy fails</td>
660
- <td><code>vercel login</code> then retry</td>
661
- </tr>
662
- <tr>
663
- <td>No markdown found</td>
664
- <td>Check <code>docs/</code> directory exists</td>
665
- </tr>
666
- <tr>
667
- <td>CSS not loading</td>
668
- <td>Update to latest version</td>
669
- </tr>
670
- <tr>
671
- <td>Port in use</td>
672
- <td><code>--port 8080</code></td>
673
- </tr>
674
- <tr>
675
- <td>Config not loading</td>
676
- <td>Check filename and format</td>
677
- </tr>
678
- <tr>
679
- <td>404 after deploy</td>
680
- <td>Check Deployment Protection settings</td>
681
- </tr>
682
- </tbody></table>
683
- <hr>
684
- <h2>Document History</h2>
685
- <table>
686
- <thead>
687
- <tr>
688
- <th>Date</th>
689
- <th>Version</th>
690
- <th>Author</th>
691
- <th>Changes</th>
692
- </tr>
693
- </thead>
694
- <tbody><tr>
695
- <td>2025-07-21</td>
696
- <td>1.0</td>
697
- <td>System</td>
698
- <td>Initial troubleshooting guide</td>
699
- </tr>
700
- </tbody></table>
701
-
702
- </div>
703
- </main>
704
- </div>
705
-
706
- <!-- Scripts -->
707
- <script>
708
- // Pass configuration to frontend
709
- window.docBuilderConfig = {
710
- features: {
711
- showPdfDownload: true,
712
- menuDefaultOpen: false,
713
- mermaidEnhanced: true
714
- }
715
- };
716
- </script>
717
- <script src="../js/main.js"></script>
718
-
719
- </body>
720
- </html>