@knowcode/doc-builder 1.9.29 → 1.9.31

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 (197) hide show
  1. package/assets/js/main.js +7 -0
  2. package/lib/core-builder.js +18 -1
  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/grant-access.sql +0 -15
  36. package/html/11.png +0 -0
  37. package/html/404.html +0 -115
  38. package/html/README.html +0 -522
  39. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  40. package/html/about-doc-builder.html +0 -491
  41. package/html/auth.js +0 -157
  42. package/html/claude-workflow-guide.html +0 -525
  43. package/html/css/notion-style.css +0 -2502
  44. package/html/documentation-index.html +0 -471
  45. package/html/guides/authentication-default-change.html +0 -370
  46. package/html/guides/authentication-guide.html +0 -509
  47. package/html/guides/cache-control-anti-pattern.html +0 -361
  48. package/html/guides/claude-workflow-guide.html +0 -1074
  49. package/html/guides/configuration-guide.html +0 -472
  50. package/html/guides/document-standards.html +0 -518
  51. package/html/guides/documentation-standards.html +0 -694
  52. package/html/guides/html-embedding-guide.html +0 -461
  53. package/html/guides/image-modal-guide.html +0 -515
  54. package/html/guides/next-steps-walkthrough.html +0 -638
  55. package/html/guides/phosphor-icons-guide.html +0 -584
  56. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  57. package/html/guides/private-directory-authentication.html +0 -541
  58. package/html/guides/public-site-deployment.html +0 -431
  59. package/html/guides/search-engine-verification-guide.html +0 -542
  60. package/html/guides/seo-guide.html +0 -661
  61. package/html/guides/seo-optimization-guide.html +0 -887
  62. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  63. package/html/guides/supabase-auth-integration-plan.html +0 -671
  64. package/html/guides/supabase-auth-setup-guide.html +0 -498
  65. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  66. package/html/guides/troubleshooting-guide.html +0 -633
  67. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  68. package/html/guides/windows-setup-guide.html +0 -859
  69. package/html/image-modal-test.html +0 -318
  70. package/html/index.html +0 -522
  71. package/html/js/auth.js +0 -157
  72. package/html/js/main.js +0 -1747
  73. package/html/launch/README.html +0 -297
  74. package/html/launch/bubble-plugin-specification.html +0 -933
  75. package/html/launch/go-to-market-strategy.html +0 -663
  76. package/html/launch/launch-announcements.html +0 -593
  77. package/html/login.html +0 -102
  78. package/html/logout.html +0 -18
  79. package/html/private/cache-control-anti-pattern.html +0 -429
  80. package/html/private/launch/README.html +0 -371
  81. package/html/private/launch/auth-cleanup-summary.html +0 -361
  82. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  83. package/html/private/launch/go-to-market-strategy.html +0 -737
  84. package/html/private/launch/launch-announcements.html +0 -667
  85. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  86. package/html/private/next-steps-walkthrough.html +0 -679
  87. package/html/private/supabase-auth-implementation-completed.html +0 -454
  88. package/html/private/supabase-auth-implementation-plan.html +0 -594
  89. package/html/private/supabase-auth-integration-plan.html +0 -704
  90. package/html/private/supabase-auth-setup-guide.html +0 -555
  91. package/html/private/test-private-doc.html +0 -302
  92. package/html/private/user-management-tooling.html +0 -601
  93. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  94. package/html/prompts/beautiful-documentation-design.html +0 -784
  95. package/html/prompts/markdown-document-standards.html +0 -422
  96. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  97. package/html/robots.txt +0 -9
  98. package/html/sitemap.xml +0 -357
  99. package/html/test-questions/how-does-it-work%3F.html +0 -294
  100. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  101. package/html/test-questions/what-is-the-purpose.html +0 -293
  102. package/html/test-status.html +0 -281
  103. package/html/vercel-cli-setup-guide.html +0 -495
  104. package/html/vercel-first-time-setup-guide.html +0 -454
  105. package/html/vercel.json +0 -29
  106. package/html-static/11.png +0 -0
  107. package/html-static/404.html +0 -115
  108. package/html-static/README.html +0 -599
  109. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  110. package/html-static/about-doc-builder.html +0 -568
  111. package/html-static/css/notion-style.css +0 -2502
  112. package/html-static/documentation-index.html +0 -548
  113. package/html-static/guides/authentication-default-change.html +0 -447
  114. package/html-static/guides/authentication-guide.html +0 -586
  115. package/html-static/guides/claude-workflow-guide.html +0 -1151
  116. package/html-static/guides/configuration-guide.html +0 -549
  117. package/html-static/guides/documentation-standards.html +0 -771
  118. package/html-static/guides/html-embedding-guide.html +0 -538
  119. package/html-static/guides/image-modal-guide.html +0 -592
  120. package/html-static/guides/phosphor-icons-guide.html +0 -661
  121. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -632
  122. package/html-static/guides/private-directory-authentication.html +0 -618
  123. package/html-static/guides/public-site-deployment.html +0 -508
  124. package/html-static/guides/search-engine-verification-guide.html +0 -619
  125. package/html-static/guides/seo-guide.html +0 -738
  126. package/html-static/guides/seo-optimization-guide.html +0 -964
  127. package/html-static/guides/supabase-authentication-complete-guide.html +0 -943
  128. package/html-static/guides/troubleshooting-guide.html +0 -710
  129. package/html-static/guides/windows-setup-guide.html +0 -936
  130. package/html-static/image-modal-test.html +0 -395
  131. package/html-static/index.html +0 -599
  132. package/html-static/js/main.js +0 -1747
  133. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  134. package/html-static/prompts/beautiful-documentation-design.html +0 -861
  135. package/html-static/prompts/markdown-document-standards.html +0 -499
  136. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -607
  137. package/html-static/robots.txt +0 -5
  138. package/html-static/sitemap.xml +0 -195
  139. package/html-static/test-questions/how-does-it-work%3F.html +0 -371
  140. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -366
  141. package/html-static/test-questions/what-is-the-purpose.html +0 -370
  142. package/html-static/vercel-cli-setup-guide.html +0 -572
  143. package/html-static/vercel-first-time-setup-guide.html +0 -531
  144. package/manage-users.sql +0 -191
  145. package/migrate-to-domain-auth.sql +0 -47
  146. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  147. package/package/CHANGELOG.md +0 -902
  148. package/package/README.md +0 -248
  149. package/package/assets/css/notion-style.css +0 -2211
  150. package/package/assets/js/auth.js +0 -67
  151. package/package/assets/js/main.js +0 -1565
  152. package/package/cli.js +0 -764
  153. package/package/index.js +0 -38
  154. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  155. package/package/lib/builder.js +0 -32
  156. package/package/lib/config.js +0 -278
  157. package/package/lib/core-builder.js +0 -957
  158. package/package/lib/deploy.js +0 -497
  159. package/package/lib/dev-server.js +0 -96
  160. package/package/package.json +0 -34
  161. package/package/scripts/npx-runner.js +0 -27
  162. package/package/scripts/setup.js +0 -56
  163. package/package/test-cache-bust.sh +0 -43
  164. package/public-config.js +0 -22
  165. package/public-html/404.html +0 -115
  166. package/public-html/README.html +0 -149
  167. package/public-html/css/notion-style.css +0 -2036
  168. package/public-html/index.html +0 -149
  169. package/public-html/js/auth.js +0 -67
  170. package/public-html/js/main.js +0 -1485
  171. package/quick-test-commands.md +0 -40
  172. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  173. package/recordings/mh-ls-22jul.txt +0 -2305
  174. package/screenshot.png +0 -0
  175. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  176. package/setup-database-v2.sql +0 -53
  177. package/setup-database.sql +0 -41
  178. package/test-auth-config.js +0 -17
  179. package/test-cache-bust.sh +0 -43
  180. package/test-docs/README.md +0 -39
  181. package/test-html/404.html +0 -115
  182. package/test-html/README.html +0 -172
  183. package/test-html/auth.js +0 -97
  184. package/test-html/css/notion-style.css +0 -2036
  185. package/test-html/index.html +0 -172
  186. package/test-html/js/auth.js +0 -97
  187. package/test-html/js/main.js +0 -1485
  188. package/test-html/login.html +0 -102
  189. package/test-html/logout.html +0 -18
  190. package/update-domain.sql +0 -9
  191. package/user-access-view.sql +0 -49
  192. package/user-management/README.md +0 -301
  193. package/user-management/add-users.sh +0 -776
  194. package/user-management/create-user.js +0 -65
  195. package/user-management/users.txt +0 -15
  196. package/view-all-users.sql +0 -40
  197. package/wru-auth-config.js +0 -17
package/html-static/guides/windows-setup-guide.html DELETED
@@ -1,936 +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 Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
7
- <title>Windows Setup Guide for Claude Code &amp; @knowcode...</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, claude, code">
12
- <meta name="robots" content="index, follow">
13
- <link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/windows-setup-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/windows-setup-guide.html">
18
- <meta property="og:title" content="Windows Setup Guide for Claude Code &amp; @knowcode...">
19
- <meta property="og:description" content="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
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="Windows Setup Guide for Claude Code &amp; @knowcode...">
29
- <meta name="twitter:description" content="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
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": "Windows Setup Guide for Claude Code & @knowcode/doc-builder",
223
- "description": "This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...",
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:35:01.307Z",
234
- "dateModified": "2025-08-12T21:35:01.307Z",
235
- "mainEntityOfPage": {
236
- "@type": "WebPage",
237
- "@id": "https://doc-builder-delta.vercel.app/guides/windows-setup-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": "Windows Setup Guide",
258
- "item": "https://doc-builder-delta.vercel.app/guides/windows-setup-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:35 PM UTC" data-doc-builder-version="1.9.28">
272
- <!-- Breadcrumbs will be generated by JavaScript -->
273
- </nav>
274
-
275
- <!-- Main Content -->
276
- <div class="main-wrapper">
277
- <!-- Sidebar -->
278
- <aside class="sidebar">
279
- <div class="sidebar-header">
280
- <div class="filter-box">
281
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
282
- <i class="fas fa-search filter-icon"></i>
283
- </div>
284
- </div>
285
- <nav class="navigation">
286
-
287
- <div class="nav-section" data-level="0">
288
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
289
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
290
- </a>
291
- <div class="nav-content">
292
- <a href="README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
293
- <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>
294
- <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>
295
- <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>
296
- <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>
297
- <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>
298
- <div class="nav-section" data-level="1">
299
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
300
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
301
- </a>
302
- <div class="nav-content" id="nav-guides-1">
303
- <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>
304
- <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>
305
- <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>
306
- <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>
307
- <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>
308
- <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>
309
- <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>
310
- <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>
311
- <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>
312
- <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>
313
- <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>
314
- <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>
315
- <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>
316
- <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>
317
- <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>
318
- <a href="guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Troubleshooting Guide</a>
319
- <a href="guides/windows-setup-guide.html" class="nav-item active" 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>
320
- <div class="nav-section" data-level="1">
321
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
322
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
323
- </a>
324
- <div class="nav-content collapsed" id="nav-prompts-1">
325
- <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>
326
- <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>
327
- <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>
328
- <div class="nav-section" data-level="1">
329
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
330
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
331
- </a>
332
- <div class="nav-content collapsed" id="nav-test-questions-1">
333
- <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>
334
- <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>
335
- <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>
336
- </nav>
337
- <div class="resize-handle"></div>
338
- </aside>
339
-
340
- <!-- Content Area -->
341
- <main class="content">
342
- <div class="content-inner">
343
- <h1>Windows Setup Guide for Claude Code &amp; @knowcode/doc-builder</h1>
344
- <h2>Overview</h2>
345
- <p>This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real troubleshooting experience, this guide addresses common Windows-specific challenges and provides clear solutions.</p>
346
- <h2>Quick Prerequisites Overview</h2>
347
- <p><strong>Required Accounts:</strong></p>
348
- <ul>
349
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Claude Pro or Max</strong> subscription ($20-200/month) - <a href="https://claude.ai">claude.ai</a></li>
350
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Vercel</strong> account (free Hobby plan) - <a href="https://vercel.com">vercel.com</a></li>
351
- <li><i style="font-size: 1.2em" class="ph ph-star" aria-label="star"></i> <strong>GitHub</strong> account (optional but recommended) - <a href="https://github.com">github.com</a></li>
352
- </ul>
353
- <p><strong>Required Software:</strong></p>
354
- <ul>
355
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Windows 10/11 with Administrator access</li>
356
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Node.js 14+ and npm - <a href="https://nodejs.org">nodejs.org</a></li>
357
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Git for Windows - <a href="https://gitforwindows.org">gitforwindows.org</a></li>
358
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> PowerShell 5.1+ (included with Windows)</li>
359
- <li><i style="font-size: 1.2em" class="ph ph-star" aria-label="star"></i> Visual Studio Code (recommended) - <a href="https://code.visualstudio.com">code.visualstudio.com</a></li>
360
- </ul>
361
- <h2>Understanding Claude vs Claude Code</h2>
362
- <h3>What&#39;s the Difference?</h3>
363
- <p><strong>Claude.ai</strong> (Web Interface):</p>
364
- <ul>
365
- <li>Browser-based chat interface</li>
366
- <li>General-purpose AI assistant</li>
367
- <li>Good for conversations and one-off tasks</li>
368
- <li>Limited file handling capabilities</li>
369
- </ul>
370
- <p><strong>Claude Code</strong> (Command-Line Tool):</p>
371
- <ul>
372
- <li>Terminal/command-line interface</li>
373
- <li>Specialized for software development</li>
374
- <li>Direct file system access</li>
375
- <li>Can read, write, and modify multiple files</li>
376
- <li>Integrated with your development workflow</li>
377
- <li>Requires Pro or Max subscription</li>
378
- </ul>
379
- <h3>Why Claude Code for Documentation?</h3>
380
- <p>Claude Code excels at:</p>
381
- <ul>
382
- <li>Reading entire codebases</li>
383
- <li>Generating multiple markdown files</li>
384
- <li>Updating existing documentation</li>
385
- <li>Creating consistent formatting</li>
386
- <li>Working directly in your project folder</li>
387
- </ul>
388
- <h2>The Three-Part System</h2>
389
- <p>Understanding the conceptual separation is crucial:</p>
390
- <table>
391
- <tr>
392
- <td width="33%">
393
-
394
- <h3>1. Claude Code</h3>
395
- <p><strong>Purpose</strong>: Create markdown content<br><strong>What it does</strong>: AI-powered content generation<br><strong>Output</strong>: <code>.md</code> files with documentation</p>
396
- </td>
397
- <td width="33%">
398
-
399
- <h3>2. doc-builder</h3>
400
- <p><strong>Purpose</strong>: Convert MD to HTML<br><strong>What it does</strong>: Beautiful static site generation<br><strong>Output</strong>: Styled HTML website</p>
401
- </td>
402
- <td width="33%">
403
-
404
- <h3>3. Vercel</h3>
405
- <p><strong>Purpose</strong>: Host the website<br><strong>What it does</strong>: Free web hosting<br><strong>Output</strong>: Live URL for your docs</p>
406
- </td>
407
- </tr>
408
- </table>
409
-
410
- <h2>Complete Prerequisites Summary</h2>
411
- <h3>Required Accounts</h3>
412
- <table>
413
- <thead>
414
- <tr>
415
- <th>Service</th>
416
- <th>Purpose</th>
417
- <th>Requirements</th>
418
- <th>Sign Up Link</th>
419
- </tr>
420
- </thead>
421
- <tbody><tr>
422
- <td><strong>Claude</strong></td>
423
- <td>AI content generation</td>
424
- <td>Pro ($20/mo) or Max ($200/mo) plan required</td>
425
- <td><a href="https://claude.ai">claude.ai</a></td>
426
- </tr>
427
- <tr>
428
- <td><strong>GitHub</strong></td>
429
- <td>Version control</td>
430
- <td>Free account (required for Vercel)</td>
431
- <td><a href="https://github.com">github.com</a></td>
432
- </tr>
433
- <tr>
434
- <td><strong>Vercel</strong></td>
435
- <td>Free web hosting</td>
436
- <td>Free Hobby account sufficient</td>
437
- <td><a href="https://vercel.com">vercel.com</a></td>
438
- </tr>
439
- </tbody></table>
440
- <h3>Software Requirements</h3>
441
- <table>
442
- <thead>
443
- <tr>
444
- <th>Software</th>
445
- <th>Version</th>
446
- <th>Purpose</th>
447
- <th>Required?</th>
448
- </tr>
449
- </thead>
450
- <tbody><tr>
451
- <td><strong>Windows</strong></td>
452
- <td>10 or 11</td>
453
- <td>Operating system</td>
454
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
455
- </tr>
456
- <tr>
457
- <td><strong>Node.js</strong></td>
458
- <td>14.0+</td>
459
- <td>JavaScript runtime</td>
460
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
461
- </tr>
462
- <tr>
463
- <td><strong>npm</strong></td>
464
- <td>(included)</td>
465
- <td>Package manager</td>
466
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
467
- </tr>
468
- <tr>
469
- <td><strong>Git</strong></td>
470
- <td>Latest</td>
471
- <td>Version control</td>
472
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
473
- </tr>
474
- <tr>
475
- <td><strong>PowerShell</strong></td>
476
- <td>5.1+</td>
477
- <td>Command line</td>
478
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
479
- </tr>
480
- <tr>
481
- <td><strong>VS Code</strong></td>
482
- <td>Latest</td>
483
- <td>Code editor</td>
484
- <td><i style="font-size: 1.2em" class="ph ph-star" aria-label="star"></i> Recommended</td>
485
- </tr>
486
- </tbody></table>
487
- <h3>Administrative Requirements</h3>
488
- <ul>
489
- <li><strong>Administrator access</strong> on Windows (for PowerShell execution policy)</li>
490
- <li><strong>Internet connection</strong> for downloading tools and deploying</li>
491
- <li><strong>Email address</strong> for account creation</li>
492
- </ul>
493
- <h3>Installation Order</h3>
494
- <table>
495
- <thead>
496
- <tr>
497
- <th>Step</th>
498
- <th>Component</th>
499
- <th>Required For</th>
500
- <th>Download Link</th>
501
- </tr>
502
- </thead>
503
- <tbody><tr>
504
- <td>1</td>
505
- <td>Node.js &amp; npm</td>
506
- <td>doc-builder</td>
507
- <td><a href="https://nodejs.org/en/download/">Download Node.js</a></td>
508
- </tr>
509
- <tr>
510
- <td>2</td>
511
- <td>Git for Windows</td>
512
- <td>Claude Code</td>
513
- <td><a href="https://gitforwindows.org/">Download Git</a></td>
514
- </tr>
515
- <tr>
516
- <td>3</td>
517
- <td>Visual Studio Code</td>
518
- <td>Development</td>
519
- <td><a href="https://code.visualstudio.com/">Download VS Code</a></td>
520
- </tr>
521
- <tr>
522
- <td>4</td>
523
- <td>Claude Code CLI</td>
524
- <td>AI content</td>
525
- <td>Via npm (see below)</td>
526
- </tr>
527
- <tr>
528
- <td>5</td>
529
- <td>Vercel CLI</td>
530
- <td>Deployment</td>
531
- <td>Via npm (see below)</td>
532
- </tr>
533
- </tbody></table>
534
- <h3>Account Setup Checklist</h3>
535
- <ul>
536
- <li><p><input disabled="" type="checkbox">
537
- <strong>Claude Account</strong></p>
538
- <ul>
539
- <li><input disabled="" type="checkbox"> Sign up at <a href="https://claude.ai">claude.ai</a></li>
540
- <li><input disabled="" type="checkbox"> Subscribe to Pro ($20/mo) or Max ($200/mo) plan</li>
541
- <li><input disabled="" type="checkbox"> Verify email</li>
542
- <li><input disabled="" type="checkbox"> Note: Free plan does NOT include Claude Code access</li>
543
- </ul>
544
- </li>
545
- <li><p><input disabled="" type="checkbox">
546
- <strong>GitHub Account</strong> (Required)</p>
547
- <ul>
548
- <li><input disabled="" type="checkbox"> Sign up at <a href="https://github.com">github.com</a></li>
549
- <li><input disabled="" type="checkbox"> Configure username and email</li>
550
- <li><input disabled="" type="checkbox"> Enable 2FA (recommended)</li>
551
- <li><input disabled="" type="checkbox"> Required for Vercel deployment</li>
552
- </ul>
553
- </li>
554
- <li><p><input disabled="" type="checkbox">
555
- <strong>Vercel Account</strong></p>
556
- <ul>
557
- <li><input disabled="" type="checkbox"> Sign up at <a href="https://vercel.com">vercel.com</a> using GitHub</li>
558
- <li><input disabled="" type="checkbox"> Choose Hobby (free) plan</li>
559
- <li><input disabled="" type="checkbox"> Authorize Vercel to access GitHub</li>
560
- </ul>
561
- </li>
562
- </ul>
563
- <h2>Step 1: Enable PowerShell Script Execution</h2>
564
- <p><strong><i style="font-size: 1.2em" class="ph ph-warning-circle" aria-label="warning"></i> IMPORTANT</strong>: This must be done FIRST as Administrator</p>
565
- <h3>Open PowerShell as Administrator</h3>
566
- <ol>
567
- <li>Press <code>Windows + X</code></li>
568
- <li>Select <strong>Terminal (Admin)</strong> or <strong>Windows PowerShell (Admin)</strong></li>
569
- <li>Click <strong>Yes</strong> when prompted by User Account Control</li>
570
- </ol>
571
- <h3>Enable Script Execution</h3>
572
- <p>Run this command in the Administrator PowerShell:</p>
573
- <pre><code class="language-powershell">Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
574
- </code></pre>
575
- <p>When prompted, type <code>Y</code> and press Enter.</p>
576
- <h3>Verify the Change</h3>
577
- <pre><code class="language-powershell">Get-ExecutionPolicy
578
- </code></pre>
579
- <p>Should return: <code>RemoteSigned</code></p>
580
- <h2>Step 2: Install Node.js and npm</h2>
581
- <h3>Download and Install</h3>
582
- <ol>
583
- <li>Go to <a href="https://nodejs.org/en/download/">Node.js Downloads</a></li>
584
- <li>Download the <strong>Windows Installer (.msi)</strong> for your system (64-bit recommended)</li>
585
- <li>Run the installer with these settings:<ul>
586
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Accept the license agreement</li>
587
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Default installation location</li>
588
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>IMPORTANT</strong>: Ensure &quot;npm package manager&quot; is checked</li>
589
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Add to PATH (should be checked by default)</li>
590
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Automatically install necessary tools (optional but recommended)</li>
591
- </ul>
592
- </li>
593
- </ol>
594
- <h3>Verify Installation</h3>
595
- <p>Open a <strong>new</strong> PowerShell window (not as admin) and run:</p>
596
- <pre><code class="language-powershell">node -v
597
- npm -v
598
- </code></pre>
599
- <p>You should see version numbers for both commands.</p>
600
- <h3>Troubleshooting npm Issues</h3>
601
- <p>If you get &quot;running scripts is disabled&quot; error:</p>
602
- <ol>
603
- <li>You didn&#39;t enable PowerShell execution policy (go back to Step 1)</li>
604
- <li>You need to close and reopen PowerShell after installing Node.js</li>
605
- <li>Try running PowerShell as Administrator</li>
606
- </ol>
607
- <h2>Step 3: Install Git for Windows</h2>
608
- <h3>Download and Install</h3>
609
- <ol>
610
- <li>Go to <a href="https://gitforwindows.org/">Git for Windows</a></li>
611
- <li>Download the installer</li>
612
- <li>Run with these recommended settings:<ul>
613
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Use Visual Studio Code as default editor</li>
614
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Git from the command line and also from 3rd-party software</li>
615
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Use bundled OpenSSH</li>
616
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Checkout Windows-style, commit Unix-style line endings</li>
617
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Use Windows&#39; default console window</li>
618
- </ul>
619
- </li>
620
- </ol>
621
- <h3>Verify Installation</h3>
622
- <pre><code class="language-powershell">git --version
623
- </code></pre>
624
- <h2>Step 4: Set Up Claude Code</h2>
625
- <h3>Understanding Claude Plans</h3>
626
- <p>Claude Code requires a Claude Pro or Team plan subscription:</p>
627
- <table>
628
- <thead>
629
- <tr>
630
- <th>Plan</th>
631
- <th>Price</th>
632
- <th>Claude Code Access</th>
633
- <th>Best For</th>
634
- </tr>
635
- </thead>
636
- <tbody><tr>
637
- <td><strong>Free</strong></td>
638
- <td>$0/month</td>
639
- <td><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> No access</td>
640
- <td>Basic chat only</td>
641
- </tr>
642
- <tr>
643
- <td><strong>Pro</strong></td>
644
- <td>$20/month</td>
645
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
646
- <td>Individual developers</td>
647
- </tr>
648
- <tr>
649
- <td><strong>Max</strong></td>
650
- <td>$200/month</td>
651
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
652
- <td>Power users, higher limits</td>
653
- </tr>
654
- </tbody></table>
655
- <p><strong>Important</strong>: Only Pro and Max plans include Claude Code access. The free Claude.ai plan does NOT support Claude Code. See <a href="https://support.anthropic.com/en/articles/11145838-using-claude-code-with-your-pro-or-max-plan">Using Claude Code with Pro/Max Plans</a></p>
656
- <h3>Install Claude Code CLI</h3>
657
- <pre><code class="language-powershell">npm install -g @anthropic/claude-code
658
- </code></pre>
659
- <h3>Initialize Claude Code</h3>
660
- <pre><code class="language-powershell">claude
661
- </code></pre>
662
- <p>Follow the prompts:</p>
663
- <ol>
664
- <li>Choose <strong>Dark mode</strong> or <strong>Light mode</strong></li>
665
- <li>Select <strong>Login with Claude account</strong></li>
666
- <li>Authorize in your browser</li>
667
- <li>Return to terminal when complete</li>
668
- </ol>
669
- <h3>Verify Setup</h3>
670
- <pre><code class="language-powershell">claude --version
671
- </code></pre>
672
- <h2>Step 5: Install @knowcode/doc-builder</h2>
673
- <h3>Global Installation (Recommended)</h3>
674
- <pre><code class="language-powershell">npm install -g @knowcode/doc-builder@latest
675
- </code></pre>
676
- <h3>Verify Installation</h3>
677
- <pre><code class="language-powershell">doc-builder --version
678
- </code></pre>
679
- <h3>Create Project Folder</h3>
680
- <pre><code class="language-powershell">cd Documents
681
- mkdir my-docs-project
682
- cd my-docs-project
683
- </code></pre>
684
- <h2>Step 6: Set Up Vercel</h2>
685
- <h3>Understanding Vercel Plans</h3>
686
- <table>
687
- <thead>
688
- <tr>
689
- <th>Plan</th>
690
- <th>Price</th>
691
- <th>Features</th>
692
- <th>Best For</th>
693
- </tr>
694
- </thead>
695
- <tbody><tr>
696
- <td><strong>Hobby</strong></td>
697
- <td>Free</td>
698
- <td>Unlimited static sites, HTTPS, Global CDN</td>
699
- <td>Personal projects, documentation</td>
700
- </tr>
701
- <tr>
702
- <td><strong>Pro</strong></td>
703
- <td>$20/month</td>
704
- <td>Team features, analytics, support</td>
705
- <td>Professional use</td>
706
- </tr>
707
- </tbody></table>
708
- <p>The free Hobby plan is perfect for documentation sites!</p>
709
- <h3>Create GitHub Account First</h3>
710
- <ol>
711
- <li>Go to <a href="https://github.com">GitHub</a></li>
712
- <li>Click <strong>Sign Up</strong></li>
713
- <li>Create username and verify email</li>
714
- <li>Complete account setup</li>
715
- </ol>
716
- <h3>Create Vercel Account (Requires GitHub)</h3>
717
- <ol>
718
- <li>Go to <a href="https://vercel.com">Vercel</a></li>
719
- <li>Click <strong>Sign Up</strong></li>
720
- <li>Choose <strong>Continue with GitHub</strong> (recommended)</li>
721
- <li>Authorize Vercel to access your GitHub</li>
722
- <li>Select <strong>Hobby</strong> plan (free)</li>
723
- </ol>
724
- <h3>Install Vercel CLI</h3>
725
- <pre><code class="language-powershell">npm install -g vercel@latest
726
- </code></pre>
727
- <h3>Login to Vercel</h3>
728
- <pre><code class="language-powershell">vercel login
729
- </code></pre>
730
- <p>This will open your browser for authentication.</p>
731
- <h2>Step 7: Complete Workflow Example</h2>
732
- <h3>1. Create Documentation with Claude Code</h3>
733
- <p>In Visual Studio Code terminal:</p>
734
- <pre><code class="language-powershell">claude
735
- </code></pre>
736
- <p>Then ask Claude to create documentation:</p>
737
- <pre><code>Create a comprehensive technical documentation for my API including authentication, endpoints, and examples
738
- </code></pre>
739
- <h3>2. Build HTML with doc-builder</h3>
740
- <pre><code class="language-powershell">doc-builder build
741
- </code></pre>
742
- <h3>3. Deploy to Vercel</h3>
743
- <pre><code class="language-powershell">doc-builder deploy
744
- </code></pre>
745
- <h4>First Deployment Setup Questions</h4>
746
- <p>You&#39;ll be prompted with several questions. Here&#39;s what each one means:</p>
747
- <p><strong>1. &quot;Set up and deploy?&quot;</strong> → Type <code>Y</code> (Yes)</p>
748
- <ul>
749
- <li>This confirms you want to deploy your documentation to Vercel</li>
750
- </ul>
751
- <p><strong>2. &quot;What is your project name?&quot;</strong> → Example: <code>my-api-docs</code></p>
752
- <ul>
753
- <li>This becomes your URL: <code>https://my-api-docs.vercel.app</code></li>
754
- <li>Also used as the project identifier in Vercel dashboard</li>
755
- </ul>
756
- <p> <strong>Naming Requirements:</strong></p>
757
- <ul>
758
- <li>Must be <strong>lowercase</strong> only</li>
759
- <li>Up to 100 characters long</li>
760
- <li>Can include: letters, numbers, <code>.</code> <code>_</code> <code>-</code></li>
761
- <li>Cannot contain: <code>---</code> (three consecutive hyphens)</li>
762
- <li>Must start with a letter</li>
763
- </ul>
764
- <p> <strong>Good examples:</strong> <code>my-docs</code>, <code>api-docs-v2</code>, <code>team_handbook</code><br> <strong>Bad examples:</strong> <code>My-Docs</code> (uppercase), <code>123-docs</code> (starts with number), <code>my---docs</code> (triple hyphen)</p>
765
- <p><strong>3. &quot;Which scope do you want to deploy to?&quot;</strong> → Select your account</p>
766
- <ul>
767
- <li>Choose your personal account or team name</li>
768
- </ul>
769
- <p><strong>4. &quot;Link to existing project?&quot;</strong> → Type <code>N</code> (No) for first time</p>
770
- <ul>
771
- <li>Choose <code>Y</code> only if you&#39;ve already created this project before</li>
772
- </ul>
773
- <p><strong>5. &quot;What&#39;s the name of your existing project?&quot;</strong> → Skip if you chose No above</p>
774
- <p><strong>6. &quot;In which directory is your code located?&quot;</strong> → Press Enter (accepts <code>./</code>)</p>
775
- <ul>
776
- <li>doc-builder already handles this correctly</li>
777
- </ul>
778
- <p><strong>7. &quot;Want to modify these settings?&quot;</strong> → Type <code>N</code> (No)</p>
779
- <ul>
780
- <li>The default settings are configured correctly by doc-builder</li>
781
- </ul>
782
- <h3>4. Make Site Public</h3>
783
- <p>After deployment:</p>
784
- <ol>
785
- <li>Go to <a href="https://vercel.com/dashboard">Vercel Dashboard</a></li>
786
- <li>Click your project</li>
787
- <li>Go to <strong>Settings</strong> → <strong>Deployment Protection</strong></li>
788
- <li>Set <strong>Vercel Authentication</strong> to <strong>Disabled</strong></li>
789
- <li>Click <strong>Save</strong></li>
790
- </ol>
791
- <p>Your documentation is now live at <code>https://your-project.vercel.app</code>!</p>
792
- <h2>Common Windows Issues &amp; Solutions</h2>
793
- <h3>PowerShell Execution Policy Error</h3>
794
- <p><strong>Error</strong>: &quot;running scripts is disabled on this system&quot;</p>
795
- <p><strong>Solution</strong>:</p>
796
- <pre><code class="language-powershell"># Run PowerShell as Administrator
797
- Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
798
- </code></pre>
799
- <p>See detailed guide: <a href="https://dev.to/jackfd120/resolving-npm-execution-policy-error-in-powershell-a-step-by-step-guide-for-developers-32ip">Resolving npm Execution Policy Error</a></p>
800
- <h3>npm Command Not Found</h3>
801
- <p><strong>Causes</strong>:</p>
802
- <ol>
803
- <li>Node.js not installed properly</li>
804
- <li>PATH not updated</li>
805
- <li>Need to restart PowerShell</li>
806
- </ol>
807
- <p><strong>Solution</strong>:</p>
808
- <ol>
809
- <li>Reinstall Node.js using the official installer</li>
810
- <li>Ensure &quot;Add to PATH&quot; is checked during installation</li>
811
- <li>Close all PowerShell windows and open new ones</li>
812
- </ol>
813
- <h3>Git Bash Required Error</h3>
814
- <p><strong>Error</strong>: &quot;Claude Code requires Git bash&quot;</p>
815
- <p><strong>Solution</strong>:<br>Install Git for Windows from <a href="https://gitforwindows.org/">gitforwindows.org</a></p>
816
- <h3>Vercel CLI Authentication Issues</h3>
817
- <p><strong>Error</strong>: &quot;Please login to Vercel&quot;</p>
818
- <p><strong>Solution</strong>:</p>
819
- <pre><code class="language-powershell">vercel logout
820
- vercel login
821
- </code></pre>
822
- <h3>Vercel Project Naming Errors</h3>
823
- <p><strong>Error</strong>: &quot;Invalid project name&quot; or deployment fails</p>
824
- <p><strong>Common Causes</strong>:</p>
825
- <ol>
826
- <li>Project name contains uppercase letters</li>
827
- <li>Project name starts with a number</li>
828
- <li>Project name contains invalid characters</li>
829
- <li>Project name contains <code>---</code> (three hyphens)</li>
830
- </ol>
831
- <p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
832
- <ul>
833
- <li><strong>Lowercase only</strong>: <code>my-docs</code> <i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i>, <code>My-Docs</code> <i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i></li>
834
- <li><strong>Start with letter</strong>: <code>api-docs</code> <i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i>, <code>123-docs</code> <i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i></li>
835
- <li><strong>Valid characters</strong>: Letters, numbers, <code>.</code>, <code>_</code>, <code>-</code></li>
836
- <li><strong>No triple hyphens</strong>: <code>my-cool-docs</code> <i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i>, <code>my---docs</code> <i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i></li>
837
- </ul>
838
- <p><strong>Examples of valid names</strong>:</p>
839
- <ul>
840
- <li><code>my-documentation</code></li>
841
- <li><code>api-docs-v2</code></li>
842
- <li><code>team_handbook</code></li>
843
- <li><code>docs.myproject</code></li>
844
- </ul>
845
- <h2>Best Practices</h2>
846
- <h3>Folder Structure</h3>
847
- <pre><code>Documents/
848
- ├── my-projects/
849
- │ ├── project1-docs/
850
- │ │ ├── docs/ # Markdown files
851
- │ │ ├── html/ # Generated HTML
852
- │ │ └── doc-builder.config.js
853
- │ └── project2-docs/
854
- </code></pre>
855
- <h3>Workflow Tips</h3>
856
- <ol>
857
- <li><strong>Use Visual Studio Code</strong> - Better terminal integration</li>
858
- <li><strong>Create separate folders</strong> for each documentation project</li>
859
- <li><strong>Use @latest</strong> - Always use <code>@latest</code> to avoid npm cache issues</li>
860
- <li><strong>Regular commits</strong> - Use Git to track changes</li>
861
- </ol>
862
- <h3>Security Notes</h3>
863
- <ol>
864
- <li><strong>Run as Admin only when required</strong> - Only for PowerShell policy changes</li>
865
- <li><strong>Keep credentials secure</strong> - Don&#39;t share Claude or Vercel tokens</li>
866
- <li><strong>Use .gitignore</strong> - Exclude sensitive files from Git</li>
867
- </ol>
868
- <h2>Quick Reference Commands</h2>
869
- <h3>Daily Workflow</h3>
870
- <pre><code class="language-powershell"># 1. Create/edit content
871
- claude
872
-
873
- # 2. Build HTML
874
- doc-builder build
875
-
876
- # 3. Deploy updates
877
- doc-builder deploy --prod
878
- </code></pre>
879
- <h3>Troubleshooting Commands</h3>
880
- <pre><code class="language-powershell"># Check installations
881
- node -v
882
- npm -v
883
- git --version
884
- claude --version
885
- vercel --version
886
-
887
- # Update tools
888
- npm update -g @knowcode/doc-builder@latest
889
- npm update -g vercel@latest
890
-
891
- # Clear npm cache
892
- npm cache clean --force
893
- </code></pre>
894
- <h2>Additional Resources</h2>
895
- <h3>Official Documentation</h3>
896
- <ul>
897
- <li><a href="https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows">Node.js on Windows Guide</a></li>
898
- <li><a href="https://vercel.com/docs/cli">Vercel CLI Documentation</a></li>
899
- <li><a href="https://support.anthropic.com/en/articles/11145838-using-claude-code-with-your-pro-or-max-plan">Claude Code with Pro/Max Plans</a></li>
900
- <li><a href="https://www.npmjs.com/package/@knowcode/doc-builder">@knowcode/doc-builder on npm</a></li>
901
- </ul>
902
- <h3>Troubleshooting Guides</h3>
903
- <ul>
904
- <li><a href="https://dev.to/jackfd120/resolving-npm-execution-policy-error-in-powershell-a-step-by-step-guide-for-developers-32ip">PowerShell Execution Policy</a></li>
905
- <li><a href="https://gitforwindows.org/">Git for Windows Setup</a></li>
906
- </ul>
907
- <h2>Conclusion</h2>
908
- <p>With this setup, you can create professional documentation in minutes:</p>
909
- <ol>
910
- <li><strong>Claude Code</strong> generates the content</li>
911
- <li><strong>doc-builder</strong> makes it beautiful</li>
912
- <li><strong>Vercel</strong> shares it with the world</li>
913
- </ol>
914
- <p>The initial setup takes about 30 minutes, but once configured, you can create and deploy documentation sites in under 5 minutes!</p>
915
- <hr>
916
- <p><strong>Need help?</strong> File issues at the respective project repositories or check the troubleshooting sections above.</p>
917
-
918
- </div>
919
- </main>
920
- </div>
921
-
922
- <!-- Scripts -->
923
- <script>
924
- // Pass configuration to frontend
925
- window.docBuilderConfig = {
926
- features: {
927
- showPdfDownload: true,
928
- menuDefaultOpen: false,
929
- mermaidEnhanced: true
930
- }
931
- };
932
- </script>
933
- <script src="../js/main.js"></script>
934
-
935
- </body>
936
- </html>