@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/guides/windows-setup-guide.html DELETED
@@ -1,859 +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
-
51
-
52
- <!-- Hide content until auth check -->
53
- <style>
54
- body {
55
- visibility: hidden;
56
- opacity: 0;
57
- transition: opacity 0.3s ease;
58
- }
59
- body.authenticated {
60
- visibility: visible;
61
- opacity: 1;
62
- }
63
- /* Show login/logout pages immediately */
64
- body.auth-page {
65
- visibility: visible;
66
- opacity: 1;
67
- }
68
- /* Style auth button consistently */
69
- .auth-btn {
70
- background: none;
71
- border: none;
72
- color: var(--text-secondary);
73
- cursor: pointer;
74
- padding: 0.5rem;
75
- border-radius: 0.5rem;
76
- transition: all 0.2s;
77
- font-size: 1.1rem;
78
- }
79
- .auth-btn:hover {
80
- background: var(--bg-secondary);
81
- color: var(--text-primary);
82
- }
83
- </style>
84
-
85
-
86
- <!-- Favicon -->
87
- <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>✨</text></svg>">
88
-
89
- <script type="application/ld+json">
90
- {
91
- "@context": "https://schema.org",
92
- "@type": "TechArticle",
93
- "headline": "Windows Setup Guide for Claude Code & @knowcode/doc-builder",
94
- "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...",
95
- "author": {
96
- "@type": "Person",
97
- "name": "Lindsay Smith"
98
- },
99
- "publisher": {
100
- "@type": "Organization",
101
- "name": "Knowcode Ltd",
102
- "url": "https://knowcode.tech"
103
- },
104
- "datePublished": "2025-08-12T21:40:09.405Z",
105
- "dateModified": "2025-08-12T21:40:09.405Z",
106
- "mainEntityOfPage": {
107
- "@type": "WebPage",
108
- "@id": "https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html"
109
- },
110
- "breadcrumb": {
111
- "@type": "BreadcrumbList",
112
- "itemListElement": [
113
- {
114
- "@type": "ListItem",
115
- "position": 1,
116
- "name": "@knowcode/doc-builder",
117
- "item": "https://doc-builder-delta.vercel.app"
118
- },
119
- {
120
- "@type": "ListItem",
121
- "position": 2,
122
- "name": "Guides",
123
- "item": "https://doc-builder-delta.vercel.app/guides/"
124
- },
125
- {
126
- "@type": "ListItem",
127
- "position": 3,
128
- "name": "Windows Setup Guide",
129
- "item": "https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html"
130
- }
131
- ]
132
- }
133
- }
134
- </script>
135
- </head>
136
- <body>
137
-
138
- <!-- Header -->
139
- <header class="header">
140
- <div class="header-content">
141
- <a href="/index.html" class="logo">@knowcode/doc-builder</a>
142
-
143
- <div class="header-actions">
144
- <div class="deployment-info">
145
- <span class="deployment-date" title="Built with doc-builder v1.9.29">Last updated: Aug 12, 2025, 09:40 PM UTC</span>
146
- </div>
147
-
148
-
149
- <a href="../../login.html" class="auth-btn" title="Login/Logout">
150
- <i class="fas fa-sign-in-alt"></i>
151
- </a>
152
-
153
-
154
- <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
155
- <i class="fas fa-moon"></i>
156
- </button>
157
-
158
- <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
159
- <i class="fas fa-bars"></i>
160
- </button>
161
- </div>
162
- </div>
163
- </header>
164
-
165
-
166
-
167
-
168
- <!-- Breadcrumbs -->
169
- <nav class="breadcrumbs " id="breadcrumbs" >
170
- <!-- Breadcrumbs will be generated by JavaScript -->
171
- </nav>
172
-
173
- <!-- Main Content -->
174
- <div class="main-wrapper">
175
- <!-- Sidebar -->
176
- <aside class="sidebar">
177
- <div class="sidebar-header">
178
- <div class="filter-box">
179
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
180
- <i class="fas fa-search filter-icon"></i>
181
- </div>
182
- </div>
183
- <nav class="navigation">
184
-
185
- <div class="nav-section" data-level="0">
186
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
187
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
188
- </a>
189
- <div class="nav-content">
190
- <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
191
- <a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
192
- <a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
193
- <a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
194
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
195
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
196
- <div class="nav-section" data-level="1">
197
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
198
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
199
- </a>
200
- <div class="nav-content" id="nav-guides-1">
201
- <a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
202
- <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="ph ph-check-circle" style="color: #059669;"></i> Authentication Guide</a>
203
- <a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
204
- <a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration Guide</a>
205
- <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
206
- <a href="/guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</a>
207
- <a href="/guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="ph ph-check-circle" style="color: #059669;"></i> Image Modal Guide</a>
208
- <a href="/guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
209
- <a href="/guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
210
- <a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</a>
211
- <a href="/guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
212
- <a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
213
- <a href="/guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
214
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
215
- <a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete Guide</a>
216
- <a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Troubleshooting Guide</a>
217
- <a href="/guides/windows-setup-guide.html" class="nav-item 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: #059669;"></i> Windows Setup Guide</a></div></div>
218
- <div class="nav-section private-nav" data-level="1">
219
- <a class="nav-title collapsible" href="#" data-target="nav-private-1" >
220
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-lock"></i> Private
221
- </a>
222
- <div class="nav-content collapsed" id="nav-private-1">
223
- <a href="/private/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="ph ph-check-circle" style="color: #059669;"></i> Cache Control Anti Pattern</a>
224
- <a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we&#039;ve implemented Supabase authentication, let&#039;s walk through testing the implementation and preparing for deployment."><i class="ph ph-check-circle" style="color: #059669;"></i> Next Steps Walkthrough</a>
225
- <a href="/private/supabase-auth-implementation-completed.html" class="nav-item" data-tooltip="This document records the successful implementation of Supabase authentication in @knowcode/doc-builder v1.7.5+."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Completed</a>
226
- <a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Plan</a>
227
- <a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Integration Plan</a>
228
- <a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Setup Guide</a>
229
- <a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="ph ph-file-text"></i> Test Private Doc</a>
230
- <a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="ph ph-check-circle" style="color: #059669;"></i> User Management Tooling</a></div></div>
231
- <div class="nav-section private-nav" data-level="2">
232
- <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
233
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-rocket-launch"></i> Launch
234
- </a>
235
- <div class="nav-content collapsed" id="nav-private-launch-2">
236
- <a href="/private/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Overview</a>
237
- <a href="/private/launch/auth-cleanup-summary.html" class="nav-item" data-tooltip="All references to the old client-side authentication system have been removed from @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Auth Cleanup Summary</a>
238
- <a href="/private/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Bubble Plugin Specification</a>
239
- <a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy &amp; Product Launch Plan."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Go To Market Strategy</a>
240
- <a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Announcements</a>
241
- <a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Deployment Auth Setup</a></div></div>
242
- <div class="nav-section" data-level="1">
243
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
244
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
245
- </a>
246
- <div class="nav-content collapsed" id="nav-prompts-1">
247
- <a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
248
- <a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
249
- <a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to &quot;sasha-publish&quot;, including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
250
- <div class="nav-section" data-level="1">
251
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
252
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
253
- </a>
254
- <div class="nav-content collapsed" id="nav-test-questions-1">
255
- <a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
256
- <a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
257
- <a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
258
- </nav>
259
- <div class="resize-handle"></div>
260
- </aside>
261
-
262
- <!-- Content Area -->
263
- <main class="content">
264
- <div class="content-inner">
265
- <h1>Windows Setup Guide for Claude Code &amp; @knowcode/doc-builder</h1>
266
- <h2>Overview</h2>
267
- <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>
268
- <h2>Quick Prerequisites Overview</h2>
269
- <p><strong>Required Accounts:</strong></p>
270
- <ul>
271
- <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>
272
- <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>
273
- <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>
274
- </ul>
275
- <p><strong>Required Software:</strong></p>
276
- <ul>
277
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Windows 10/11 with Administrator access</li>
278
- <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>
279
- <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>
280
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> PowerShell 5.1+ (included with Windows)</li>
281
- <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>
282
- </ul>
283
- <h2>Understanding Claude vs Claude Code</h2>
284
- <h3>What&#39;s the Difference?</h3>
285
- <p><strong>Claude.ai</strong> (Web Interface):</p>
286
- <ul>
287
- <li>Browser-based chat interface</li>
288
- <li>General-purpose AI assistant</li>
289
- <li>Good for conversations and one-off tasks</li>
290
- <li>Limited file handling capabilities</li>
291
- </ul>
292
- <p><strong>Claude Code</strong> (Command-Line Tool):</p>
293
- <ul>
294
- <li>Terminal/command-line interface</li>
295
- <li>Specialized for software development</li>
296
- <li>Direct file system access</li>
297
- <li>Can read, write, and modify multiple files</li>
298
- <li>Integrated with your development workflow</li>
299
- <li>Requires Pro or Max subscription</li>
300
- </ul>
301
- <h3>Why Claude Code for Documentation?</h3>
302
- <p>Claude Code excels at:</p>
303
- <ul>
304
- <li>Reading entire codebases</li>
305
- <li>Generating multiple markdown files</li>
306
- <li>Updating existing documentation</li>
307
- <li>Creating consistent formatting</li>
308
- <li>Working directly in your project folder</li>
309
- </ul>
310
- <h2>The Three-Part System</h2>
311
- <p>Understanding the conceptual separation is crucial:</p>
312
- <table>
313
- <tr>
314
- <td width="33%">
315
-
316
- <h3>1. Claude Code</h3>
317
- <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>
318
- </td>
319
- <td width="33%">
320
-
321
- <h3>2. doc-builder</h3>
322
- <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>
323
- </td>
324
- <td width="33%">
325
-
326
- <h3>3. Vercel</h3>
327
- <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>
328
- </td>
329
- </tr>
330
- </table>
331
-
332
- <h2>Complete Prerequisites Summary</h2>
333
- <h3>Required Accounts</h3>
334
- <table>
335
- <thead>
336
- <tr>
337
- <th>Service</th>
338
- <th>Purpose</th>
339
- <th>Requirements</th>
340
- <th>Sign Up Link</th>
341
- </tr>
342
- </thead>
343
- <tbody><tr>
344
- <td><strong>Claude</strong></td>
345
- <td>AI content generation</td>
346
- <td>Pro ($20/mo) or Max ($200/mo) plan required</td>
347
- <td><a href="https://claude.ai">claude.ai</a></td>
348
- </tr>
349
- <tr>
350
- <td><strong>GitHub</strong></td>
351
- <td>Version control</td>
352
- <td>Free account (required for Vercel)</td>
353
- <td><a href="https://github.com">github.com</a></td>
354
- </tr>
355
- <tr>
356
- <td><strong>Vercel</strong></td>
357
- <td>Free web hosting</td>
358
- <td>Free Hobby account sufficient</td>
359
- <td><a href="https://vercel.com">vercel.com</a></td>
360
- </tr>
361
- </tbody></table>
362
- <h3>Software Requirements</h3>
363
- <table>
364
- <thead>
365
- <tr>
366
- <th>Software</th>
367
- <th>Version</th>
368
- <th>Purpose</th>
369
- <th>Required?</th>
370
- </tr>
371
- </thead>
372
- <tbody><tr>
373
- <td><strong>Windows</strong></td>
374
- <td>10 or 11</td>
375
- <td>Operating system</td>
376
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
377
- </tr>
378
- <tr>
379
- <td><strong>Node.js</strong></td>
380
- <td>14.0+</td>
381
- <td>JavaScript runtime</td>
382
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
383
- </tr>
384
- <tr>
385
- <td><strong>npm</strong></td>
386
- <td>(included)</td>
387
- <td>Package manager</td>
388
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
389
- </tr>
390
- <tr>
391
- <td><strong>Git</strong></td>
392
- <td>Latest</td>
393
- <td>Version control</td>
394
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
395
- </tr>
396
- <tr>
397
- <td><strong>PowerShell</strong></td>
398
- <td>5.1+</td>
399
- <td>Command line</td>
400
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Required</td>
401
- </tr>
402
- <tr>
403
- <td><strong>VS Code</strong></td>
404
- <td>Latest</td>
405
- <td>Code editor</td>
406
- <td><i style="font-size: 1.2em" class="ph ph-star" aria-label="star"></i> Recommended</td>
407
- </tr>
408
- </tbody></table>
409
- <h3>Administrative Requirements</h3>
410
- <ul>
411
- <li><strong>Administrator access</strong> on Windows (for PowerShell execution policy)</li>
412
- <li><strong>Internet connection</strong> for downloading tools and deploying</li>
413
- <li><strong>Email address</strong> for account creation</li>
414
- </ul>
415
- <h3>Installation Order</h3>
416
- <table>
417
- <thead>
418
- <tr>
419
- <th>Step</th>
420
- <th>Component</th>
421
- <th>Required For</th>
422
- <th>Download Link</th>
423
- </tr>
424
- </thead>
425
- <tbody><tr>
426
- <td>1</td>
427
- <td>Node.js &amp; npm</td>
428
- <td>doc-builder</td>
429
- <td><a href="https://nodejs.org/en/download/">Download Node.js</a></td>
430
- </tr>
431
- <tr>
432
- <td>2</td>
433
- <td>Git for Windows</td>
434
- <td>Claude Code</td>
435
- <td><a href="https://gitforwindows.org/">Download Git</a></td>
436
- </tr>
437
- <tr>
438
- <td>3</td>
439
- <td>Visual Studio Code</td>
440
- <td>Development</td>
441
- <td><a href="https://code.visualstudio.com/">Download VS Code</a></td>
442
- </tr>
443
- <tr>
444
- <td>4</td>
445
- <td>Claude Code CLI</td>
446
- <td>AI content</td>
447
- <td>Via npm (see below)</td>
448
- </tr>
449
- <tr>
450
- <td>5</td>
451
- <td>Vercel CLI</td>
452
- <td>Deployment</td>
453
- <td>Via npm (see below)</td>
454
- </tr>
455
- </tbody></table>
456
- <h3>Account Setup Checklist</h3>
457
- <ul>
458
- <li><p><input disabled="" type="checkbox">
459
- <strong>Claude Account</strong></p>
460
- <ul>
461
- <li><input disabled="" type="checkbox"> Sign up at <a href="https://claude.ai">claude.ai</a></li>
462
- <li><input disabled="" type="checkbox"> Subscribe to Pro ($20/mo) or Max ($200/mo) plan</li>
463
- <li><input disabled="" type="checkbox"> Verify email</li>
464
- <li><input disabled="" type="checkbox"> Note: Free plan does NOT include Claude Code access</li>
465
- </ul>
466
- </li>
467
- <li><p><input disabled="" type="checkbox">
468
- <strong>GitHub Account</strong> (Required)</p>
469
- <ul>
470
- <li><input disabled="" type="checkbox"> Sign up at <a href="https://github.com">github.com</a></li>
471
- <li><input disabled="" type="checkbox"> Configure username and email</li>
472
- <li><input disabled="" type="checkbox"> Enable 2FA (recommended)</li>
473
- <li><input disabled="" type="checkbox"> Required for Vercel deployment</li>
474
- </ul>
475
- </li>
476
- <li><p><input disabled="" type="checkbox">
477
- <strong>Vercel Account</strong></p>
478
- <ul>
479
- <li><input disabled="" type="checkbox"> Sign up at <a href="https://vercel.com">vercel.com</a> using GitHub</li>
480
- <li><input disabled="" type="checkbox"> Choose Hobby (free) plan</li>
481
- <li><input disabled="" type="checkbox"> Authorize Vercel to access GitHub</li>
482
- </ul>
483
- </li>
484
- </ul>
485
- <h2>Step 1: Enable PowerShell Script Execution</h2>
486
- <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>
487
- <h3>Open PowerShell as Administrator</h3>
488
- <ol>
489
- <li>Press <code>Windows + X</code></li>
490
- <li>Select <strong>Terminal (Admin)</strong> or <strong>Windows PowerShell (Admin)</strong></li>
491
- <li>Click <strong>Yes</strong> when prompted by User Account Control</li>
492
- </ol>
493
- <h3>Enable Script Execution</h3>
494
- <p>Run this command in the Administrator PowerShell:</p>
495
- <pre><code class="language-powershell">Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
496
- </code></pre>
497
- <p>When prompted, type <code>Y</code> and press Enter.</p>
498
- <h3>Verify the Change</h3>
499
- <pre><code class="language-powershell">Get-ExecutionPolicy
500
- </code></pre>
501
- <p>Should return: <code>RemoteSigned</code></p>
502
- <h2>Step 2: Install Node.js and npm</h2>
503
- <h3>Download and Install</h3>
504
- <ol>
505
- <li>Go to <a href="https://nodejs.org/en/download/">Node.js Downloads</a></li>
506
- <li>Download the <strong>Windows Installer (.msi)</strong> for your system (64-bit recommended)</li>
507
- <li>Run the installer with these settings:<ul>
508
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Accept the license agreement</li>
509
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Default installation location</li>
510
- <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>
511
- <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>
512
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Automatically install necessary tools (optional but recommended)</li>
513
- </ul>
514
- </li>
515
- </ol>
516
- <h3>Verify Installation</h3>
517
- <p>Open a <strong>new</strong> PowerShell window (not as admin) and run:</p>
518
- <pre><code class="language-powershell">node -v
519
- npm -v
520
- </code></pre>
521
- <p>You should see version numbers for both commands.</p>
522
- <h3>Troubleshooting npm Issues</h3>
523
- <p>If you get &quot;running scripts is disabled&quot; error:</p>
524
- <ol>
525
- <li>You didn&#39;t enable PowerShell execution policy (go back to Step 1)</li>
526
- <li>You need to close and reopen PowerShell after installing Node.js</li>
527
- <li>Try running PowerShell as Administrator</li>
528
- </ol>
529
- <h2>Step 3: Install Git for Windows</h2>
530
- <h3>Download and Install</h3>
531
- <ol>
532
- <li>Go to <a href="https://gitforwindows.org/">Git for Windows</a></li>
533
- <li>Download the installer</li>
534
- <li>Run with these recommended settings:<ul>
535
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Use Visual Studio Code as default editor</li>
536
- <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>
537
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Use bundled OpenSSH</li>
538
- <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>
539
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Use Windows&#39; default console window</li>
540
- </ul>
541
- </li>
542
- </ol>
543
- <h3>Verify Installation</h3>
544
- <pre><code class="language-powershell">git --version
545
- </code></pre>
546
- <h2>Step 4: Set Up Claude Code</h2>
547
- <h3>Understanding Claude Plans</h3>
548
- <p>Claude Code requires a Claude Pro or Team plan subscription:</p>
549
- <table>
550
- <thead>
551
- <tr>
552
- <th>Plan</th>
553
- <th>Price</th>
554
- <th>Claude Code Access</th>
555
- <th>Best For</th>
556
- </tr>
557
- </thead>
558
- <tbody><tr>
559
- <td><strong>Free</strong></td>
560
- <td>$0/month</td>
561
- <td><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> No access</td>
562
- <td>Basic chat only</td>
563
- </tr>
564
- <tr>
565
- <td><strong>Pro</strong></td>
566
- <td>$20/month</td>
567
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
568
- <td>Individual developers</td>
569
- </tr>
570
- <tr>
571
- <td><strong>Max</strong></td>
572
- <td>$200/month</td>
573
- <td><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
574
- <td>Power users, higher limits</td>
575
- </tr>
576
- </tbody></table>
577
- <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>
578
- <h3>Install Claude Code CLI</h3>
579
- <pre><code class="language-powershell">npm install -g @anthropic/claude-code
580
- </code></pre>
581
- <h3>Initialize Claude Code</h3>
582
- <pre><code class="language-powershell">claude
583
- </code></pre>
584
- <p>Follow the prompts:</p>
585
- <ol>
586
- <li>Choose <strong>Dark mode</strong> or <strong>Light mode</strong></li>
587
- <li>Select <strong>Login with Claude account</strong></li>
588
- <li>Authorize in your browser</li>
589
- <li>Return to terminal when complete</li>
590
- </ol>
591
- <h3>Verify Setup</h3>
592
- <pre><code class="language-powershell">claude --version
593
- </code></pre>
594
- <h2>Step 5: Install @knowcode/doc-builder</h2>
595
- <h3>Global Installation (Recommended)</h3>
596
- <pre><code class="language-powershell">npm install -g @knowcode/doc-builder@latest
597
- </code></pre>
598
- <h3>Verify Installation</h3>
599
- <pre><code class="language-powershell">doc-builder --version
600
- </code></pre>
601
- <h3>Create Project Folder</h3>
602
- <pre><code class="language-powershell">cd Documents
603
- mkdir my-docs-project
604
- cd my-docs-project
605
- </code></pre>
606
- <h2>Step 6: Set Up Vercel</h2>
607
- <h3>Understanding Vercel Plans</h3>
608
- <table>
609
- <thead>
610
- <tr>
611
- <th>Plan</th>
612
- <th>Price</th>
613
- <th>Features</th>
614
- <th>Best For</th>
615
- </tr>
616
- </thead>
617
- <tbody><tr>
618
- <td><strong>Hobby</strong></td>
619
- <td>Free</td>
620
- <td>Unlimited static sites, HTTPS, Global CDN</td>
621
- <td>Personal projects, documentation</td>
622
- </tr>
623
- <tr>
624
- <td><strong>Pro</strong></td>
625
- <td>$20/month</td>
626
- <td>Team features, analytics, support</td>
627
- <td>Professional use</td>
628
- </tr>
629
- </tbody></table>
630
- <p>The free Hobby plan is perfect for documentation sites!</p>
631
- <h3>Create GitHub Account First</h3>
632
- <ol>
633
- <li>Go to <a href="https://github.com">GitHub</a></li>
634
- <li>Click <strong>Sign Up</strong></li>
635
- <li>Create username and verify email</li>
636
- <li>Complete account setup</li>
637
- </ol>
638
- <h3>Create Vercel Account (Requires GitHub)</h3>
639
- <ol>
640
- <li>Go to <a href="https://vercel.com">Vercel</a></li>
641
- <li>Click <strong>Sign Up</strong></li>
642
- <li>Choose <strong>Continue with GitHub</strong> (recommended)</li>
643
- <li>Authorize Vercel to access your GitHub</li>
644
- <li>Select <strong>Hobby</strong> plan (free)</li>
645
- </ol>
646
- <h3>Install Vercel CLI</h3>
647
- <pre><code class="language-powershell">npm install -g vercel@latest
648
- </code></pre>
649
- <h3>Login to Vercel</h3>
650
- <pre><code class="language-powershell">vercel login
651
- </code></pre>
652
- <p>This will open your browser for authentication.</p>
653
- <h2>Step 7: Complete Workflow Example</h2>
654
- <h3>1. Create Documentation with Claude Code</h3>
655
- <p>In Visual Studio Code terminal:</p>
656
- <pre><code class="language-powershell">claude
657
- </code></pre>
658
- <p>Then ask Claude to create documentation:</p>
659
- <pre><code>Create a comprehensive technical documentation for my API including authentication, endpoints, and examples
660
- </code></pre>
661
- <h3>2. Build HTML with doc-builder</h3>
662
- <pre><code class="language-powershell">doc-builder build
663
- </code></pre>
664
- <h3>3. Deploy to Vercel</h3>
665
- <pre><code class="language-powershell">doc-builder deploy
666
- </code></pre>
667
- <h4>First Deployment Setup Questions</h4>
668
- <p>You&#39;ll be prompted with several questions. Here&#39;s what each one means:</p>
669
- <p><strong>1. &quot;Set up and deploy?&quot;</strong> → Type <code>Y</code> (Yes)</p>
670
- <ul>
671
- <li>This confirms you want to deploy your documentation to Vercel</li>
672
- </ul>
673
- <p><strong>2. &quot;What is your project name?&quot;</strong> → Example: <code>my-api-docs</code></p>
674
- <ul>
675
- <li>This becomes your URL: <code>https://my-api-docs.vercel.app</code></li>
676
- <li>Also used as the project identifier in Vercel dashboard</li>
677
- </ul>
678
- <p> <strong>Naming Requirements:</strong></p>
679
- <ul>
680
- <li>Must be <strong>lowercase</strong> only</li>
681
- <li>Up to 100 characters long</li>
682
- <li>Can include: letters, numbers, <code>.</code> <code>_</code> <code>-</code></li>
683
- <li>Cannot contain: <code>---</code> (three consecutive hyphens)</li>
684
- <li>Must start with a letter</li>
685
- </ul>
686
- <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>
687
- <p><strong>3. &quot;Which scope do you want to deploy to?&quot;</strong> → Select your account</p>
688
- <ul>
689
- <li>Choose your personal account or team name</li>
690
- </ul>
691
- <p><strong>4. &quot;Link to existing project?&quot;</strong> → Type <code>N</code> (No) for first time</p>
692
- <ul>
693
- <li>Choose <code>Y</code> only if you&#39;ve already created this project before</li>
694
- </ul>
695
- <p><strong>5. &quot;What&#39;s the name of your existing project?&quot;</strong> → Skip if you chose No above</p>
696
- <p><strong>6. &quot;In which directory is your code located?&quot;</strong> → Press Enter (accepts <code>./</code>)</p>
697
- <ul>
698
- <li>doc-builder already handles this correctly</li>
699
- </ul>
700
- <p><strong>7. &quot;Want to modify these settings?&quot;</strong> → Type <code>N</code> (No)</p>
701
- <ul>
702
- <li>The default settings are configured correctly by doc-builder</li>
703
- </ul>
704
- <h3>4. Make Site Public</h3>
705
- <p>After deployment:</p>
706
- <ol>
707
- <li>Go to <a href="https://vercel.com/dashboard">Vercel Dashboard</a></li>
708
- <li>Click your project</li>
709
- <li>Go to <strong>Settings</strong> → <strong>Deployment Protection</strong></li>
710
- <li>Set <strong>Vercel Authentication</strong> to <strong>Disabled</strong></li>
711
- <li>Click <strong>Save</strong></li>
712
- </ol>
713
- <p>Your documentation is now live at <code>https://your-project.vercel.app</code>!</p>
714
- <h2>Common Windows Issues &amp; Solutions</h2>
715
- <h3>PowerShell Execution Policy Error</h3>
716
- <p><strong>Error</strong>: &quot;running scripts is disabled on this system&quot;</p>
717
- <p><strong>Solution</strong>:</p>
718
- <pre><code class="language-powershell"># Run PowerShell as Administrator
719
- Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser -Force
720
- </code></pre>
721
- <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>
722
- <h3>npm Command Not Found</h3>
723
- <p><strong>Causes</strong>:</p>
724
- <ol>
725
- <li>Node.js not installed properly</li>
726
- <li>PATH not updated</li>
727
- <li>Need to restart PowerShell</li>
728
- </ol>
729
- <p><strong>Solution</strong>:</p>
730
- <ol>
731
- <li>Reinstall Node.js using the official installer</li>
732
- <li>Ensure &quot;Add to PATH&quot; is checked during installation</li>
733
- <li>Close all PowerShell windows and open new ones</li>
734
- </ol>
735
- <h3>Git Bash Required Error</h3>
736
- <p><strong>Error</strong>: &quot;Claude Code requires Git bash&quot;</p>
737
- <p><strong>Solution</strong>:<br>Install Git for Windows from <a href="https://gitforwindows.org/">gitforwindows.org</a></p>
738
- <h3>Vercel CLI Authentication Issues</h3>
739
- <p><strong>Error</strong>: &quot;Please login to Vercel&quot;</p>
740
- <p><strong>Solution</strong>:</p>
741
- <pre><code class="language-powershell">vercel logout
742
- vercel login
743
- </code></pre>
744
- <h3>Vercel Project Naming Errors</h3>
745
- <p><strong>Error</strong>: &quot;Invalid project name&quot; or deployment fails</p>
746
- <p><strong>Common Causes</strong>:</p>
747
- <ol>
748
- <li>Project name contains uppercase letters</li>
749
- <li>Project name starts with a number</li>
750
- <li>Project name contains invalid characters</li>
751
- <li>Project name contains <code>---</code> (three hyphens)</li>
752
- </ol>
753
- <p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
754
- <ul>
755
- <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>
756
- <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>
757
- <li><strong>Valid characters</strong>: Letters, numbers, <code>.</code>, <code>_</code>, <code>-</code></li>
758
- <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>
759
- </ul>
760
- <p><strong>Examples of valid names</strong>:</p>
761
- <ul>
762
- <li><code>my-documentation</code></li>
763
- <li><code>api-docs-v2</code></li>
764
- <li><code>team_handbook</code></li>
765
- <li><code>docs.myproject</code></li>
766
- </ul>
767
- <h2>Best Practices</h2>
768
- <h3>Folder Structure</h3>
769
- <pre><code>Documents/
770
- ├── my-projects/
771
- │ ├── project1-docs/
772
- │ │ ├── docs/ # Markdown files
773
- │ │ ├── html/ # Generated HTML
774
- │ │ └── doc-builder.config.js
775
- │ └── project2-docs/
776
- </code></pre>
777
- <h3>Workflow Tips</h3>
778
- <ol>
779
- <li><strong>Use Visual Studio Code</strong> - Better terminal integration</li>
780
- <li><strong>Create separate folders</strong> for each documentation project</li>
781
- <li><strong>Use @latest</strong> - Always use <code>@latest</code> to avoid npm cache issues</li>
782
- <li><strong>Regular commits</strong> - Use Git to track changes</li>
783
- </ol>
784
- <h3>Security Notes</h3>
785
- <ol>
786
- <li><strong>Run as Admin only when required</strong> - Only for PowerShell policy changes</li>
787
- <li><strong>Keep credentials secure</strong> - Don&#39;t share Claude or Vercel tokens</li>
788
- <li><strong>Use .gitignore</strong> - Exclude sensitive files from Git</li>
789
- </ol>
790
- <h2>Quick Reference Commands</h2>
791
- <h3>Daily Workflow</h3>
792
- <pre><code class="language-powershell"># 1. Create/edit content
793
- claude
794
-
795
- # 2. Build HTML
796
- doc-builder build
797
-
798
- # 3. Deploy updates
799
- doc-builder deploy --prod
800
- </code></pre>
801
- <h3>Troubleshooting Commands</h3>
802
- <pre><code class="language-powershell"># Check installations
803
- node -v
804
- npm -v
805
- git --version
806
- claude --version
807
- vercel --version
808
-
809
- # Update tools
810
- npm update -g @knowcode/doc-builder@latest
811
- npm update -g vercel@latest
812
-
813
- # Clear npm cache
814
- npm cache clean --force
815
- </code></pre>
816
- <h2>Additional Resources</h2>
817
- <h3>Official Documentation</h3>
818
- <ul>
819
- <li><a href="https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows">Node.js on Windows Guide</a></li>
820
- <li><a href="https://vercel.com/docs/cli">Vercel CLI Documentation</a></li>
821
- <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>
822
- <li><a href="https://www.npmjs.com/package/@knowcode/doc-builder">@knowcode/doc-builder on npm</a></li>
823
- </ul>
824
- <h3>Troubleshooting Guides</h3>
825
- <ul>
826
- <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>
827
- <li><a href="https://gitforwindows.org/">Git for Windows Setup</a></li>
828
- </ul>
829
- <h2>Conclusion</h2>
830
- <p>With this setup, you can create professional documentation in minutes:</p>
831
- <ol>
832
- <li><strong>Claude Code</strong> generates the content</li>
833
- <li><strong>doc-builder</strong> makes it beautiful</li>
834
- <li><strong>Vercel</strong> shares it with the world</li>
835
- </ol>
836
- <p>The initial setup takes about 30 minutes, but once configured, you can create and deploy documentation sites in under 5 minutes!</p>
837
- <hr>
838
- <p><strong>Need help?</strong> File issues at the respective project repositories or check the troubleshooting sections above.</p>
839
-
840
- </div>
841
- </main>
842
- </div>
843
-
844
- <!-- Scripts -->
845
- <script>
846
- // Pass configuration to frontend
847
- window.docBuilderConfig = {
848
- features: {
849
- showPdfDownload: true,
850
- menuDefaultOpen: false,
851
- mermaidEnhanced: true
852
- }
853
- };
854
- </script>
855
- <script src="/js/main.js"></script>
856
- <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
857
- <script src="/js/auth.js"></script>
858
- </body>
859
- </html>