@knowcode/doc-builder 1.9.30 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/lib/core-builder.js +164 -174
  2. package/lib/emoji-mapper.js +27 -12
  3. package/package.json +12 -2
  4. package/.claude/settings.local.json +0 -56
  5. package/CACHE-BUSTING-GUIDE.md +0 -82
  6. package/CLAUDE.md +0 -86
  7. package/CONTRIBUTING.md +0 -148
  8. package/GITHUB_SETUP.md +0 -203
  9. package/RELEASE-NOTES-1.7.5.md +0 -64
  10. package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
  11. package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
  12. package/add-user-clive.sql +0 -35
  13. package/add-user-lindsay-fixed.sql +0 -85
  14. package/add-user-lindsay.sql +0 -68
  15. package/add-user-pmorgan.sql +0 -35
  16. package/add-user-robbie.sql +0 -35
  17. package/add-wru-users.sql +0 -105
  18. package/debug-login.sql +0 -30
  19. package/doc-builder.config.js +0 -126
  20. package/doc-builder.config.js.backup.1753793768283 +0 -47
  21. package/doc-builder.config.js.backup.1753803964423 +0 -114
  22. package/doc-builder.config.js.backup.1753945707032 +0 -115
  23. package/doc-builder.config.js.backup.1754059241330 +0 -115
  24. package/doc-builder.config.js.backup.1754119567787 +0 -123
  25. package/doc-builder.config.js.backup.1754120048862 +0 -124
  26. package/doc-builder.config.js.backup.1754120529913 +0 -124
  27. package/doc-builder.config.js.backup.1754218469785 +0 -124
  28. package/doc-builder.config.js.backup.1754384764054 +0 -124
  29. package/doc-builder.config.js.backup.1754567425847 +0 -124
  30. package/doc-builder.config.js.backup.1754568137859 +0 -126
  31. package/doc-builder.config.js.backup.1754569388252 +0 -126
  32. package/doc-builder.config.js.backup.1754576694123 +0 -126
  33. package/doc-builder.config.js.backup.1755031374829 +0 -126
  34. package/doc-builder.config.js.backup.1755034500990 +0 -126
  35. package/doc-builder.config.js.backup.1755034809236 +0 -126
  36. package/grant-access.sql +0 -15
  37. package/html/11.png +0 -0
  38. package/html/404.html +0 -115
  39. package/html/README.html +0 -522
  40. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  41. package/html/about-doc-builder.html +0 -491
  42. package/html/auth.js +0 -157
  43. package/html/claude-workflow-guide.html +0 -525
  44. package/html/css/notion-style.css +0 -2502
  45. package/html/documentation-index.html +0 -471
  46. package/html/guides/authentication-default-change.html +0 -370
  47. package/html/guides/authentication-guide.html +0 -509
  48. package/html/guides/cache-control-anti-pattern.html +0 -361
  49. package/html/guides/claude-workflow-guide.html +0 -1074
  50. package/html/guides/configuration-guide.html +0 -472
  51. package/html/guides/document-standards.html +0 -518
  52. package/html/guides/documentation-standards.html +0 -694
  53. package/html/guides/html-embedding-guide.html +0 -461
  54. package/html/guides/image-modal-guide.html +0 -515
  55. package/html/guides/next-steps-walkthrough.html +0 -638
  56. package/html/guides/phosphor-icons-guide.html +0 -584
  57. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  58. package/html/guides/private-directory-authentication.html +0 -541
  59. package/html/guides/public-site-deployment.html +0 -431
  60. package/html/guides/search-engine-verification-guide.html +0 -542
  61. package/html/guides/seo-guide.html +0 -661
  62. package/html/guides/seo-optimization-guide.html +0 -887
  63. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  64. package/html/guides/supabase-auth-integration-plan.html +0 -671
  65. package/html/guides/supabase-auth-setup-guide.html +0 -498
  66. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  67. package/html/guides/troubleshooting-guide.html +0 -633
  68. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  69. package/html/guides/windows-setup-guide.html +0 -859
  70. package/html/image-modal-test.html +0 -318
  71. package/html/index.html +0 -522
  72. package/html/js/auth.js +0 -157
  73. package/html/js/main.js +0 -1754
  74. package/html/launch/README.html +0 -297
  75. package/html/launch/bubble-plugin-specification.html +0 -933
  76. package/html/launch/go-to-market-strategy.html +0 -663
  77. package/html/launch/launch-announcements.html +0 -593
  78. package/html/login.html +0 -102
  79. package/html/logout.html +0 -18
  80. package/html/private/cache-control-anti-pattern.html +0 -429
  81. package/html/private/launch/README.html +0 -371
  82. package/html/private/launch/auth-cleanup-summary.html +0 -361
  83. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  84. package/html/private/launch/go-to-market-strategy.html +0 -737
  85. package/html/private/launch/launch-announcements.html +0 -667
  86. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  87. package/html/private/next-steps-walkthrough.html +0 -679
  88. package/html/private/supabase-auth-implementation-completed.html +0 -454
  89. package/html/private/supabase-auth-implementation-plan.html +0 -594
  90. package/html/private/supabase-auth-integration-plan.html +0 -704
  91. package/html/private/supabase-auth-setup-guide.html +0 -555
  92. package/html/private/test-private-doc.html +0 -302
  93. package/html/private/user-management-tooling.html +0 -601
  94. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  95. package/html/prompts/beautiful-documentation-design.html +0 -784
  96. package/html/prompts/markdown-document-standards.html +0 -422
  97. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  98. package/html/robots.txt +0 -9
  99. package/html/sitemap.xml +0 -357
  100. package/html/test-questions/how-does-it-work%3F.html +0 -294
  101. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  102. package/html/test-questions/what-is-the-purpose.html +0 -293
  103. package/html/test-status.html +0 -281
  104. package/html/vercel-cli-setup-guide.html +0 -495
  105. package/html/vercel-first-time-setup-guide.html +0 -454
  106. package/html/vercel.json +0 -29
  107. package/html-static/11.png +0 -0
  108. package/html-static/404.html +0 -115
  109. package/html-static/README.html +0 -609
  110. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  111. package/html-static/about-doc-builder.html +0 -578
  112. package/html-static/css/notion-style.css +0 -2502
  113. package/html-static/documentation-index.html +0 -558
  114. package/html-static/guides/authentication-default-change.html +0 -457
  115. package/html-static/guides/authentication-guide.html +0 -596
  116. package/html-static/guides/claude-workflow-guide.html +0 -1161
  117. package/html-static/guides/configuration-guide.html +0 -559
  118. package/html-static/guides/documentation-standards.html +0 -781
  119. package/html-static/guides/html-embedding-guide.html +0 -548
  120. package/html-static/guides/image-modal-guide.html +0 -602
  121. package/html-static/guides/phosphor-icons-guide.html +0 -671
  122. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -642
  123. package/html-static/guides/private-directory-authentication.html +0 -628
  124. package/html-static/guides/public-site-deployment.html +0 -518
  125. package/html-static/guides/search-engine-verification-guide.html +0 -629
  126. package/html-static/guides/seo-guide.html +0 -748
  127. package/html-static/guides/seo-optimization-guide.html +0 -974
  128. package/html-static/guides/supabase-authentication-complete-guide.html +0 -953
  129. package/html-static/guides/troubleshooting-guide.html +0 -720
  130. package/html-static/guides/windows-setup-guide.html +0 -946
  131. package/html-static/image-modal-test.html +0 -405
  132. package/html-static/index.html +0 -609
  133. package/html-static/js/main.js +0 -1754
  134. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  135. package/html-static/prompts/beautiful-documentation-design.html +0 -871
  136. package/html-static/prompts/markdown-document-standards.html +0 -509
  137. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -617
  138. package/html-static/robots.txt +0 -5
  139. package/html-static/sitemap.xml +0 -195
  140. package/html-static/test-questions/how-does-it-work%3F.html +0 -381
  141. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -376
  142. package/html-static/test-questions/what-is-the-purpose.html +0 -380
  143. package/html-static/vercel-cli-setup-guide.html +0 -582
  144. package/html-static/vercel-first-time-setup-guide.html +0 -541
  145. package/manage-users.sql +0 -191
  146. package/migrate-to-domain-auth.sql +0 -47
  147. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  148. package/package/CHANGELOG.md +0 -902
  149. package/package/README.md +0 -248
  150. package/package/assets/css/notion-style.css +0 -2211
  151. package/package/assets/js/auth.js +0 -67
  152. package/package/assets/js/main.js +0 -1565
  153. package/package/cli.js +0 -764
  154. package/package/index.js +0 -38
  155. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  156. package/package/lib/builder.js +0 -32
  157. package/package/lib/config.js +0 -278
  158. package/package/lib/core-builder.js +0 -957
  159. package/package/lib/deploy.js +0 -497
  160. package/package/lib/dev-server.js +0 -96
  161. package/package/package.json +0 -34
  162. package/package/scripts/npx-runner.js +0 -27
  163. package/package/scripts/setup.js +0 -56
  164. package/package/test-cache-bust.sh +0 -43
  165. package/public-config.js +0 -22
  166. package/public-html/404.html +0 -115
  167. package/public-html/README.html +0 -149
  168. package/public-html/css/notion-style.css +0 -2036
  169. package/public-html/index.html +0 -149
  170. package/public-html/js/auth.js +0 -67
  171. package/public-html/js/main.js +0 -1485
  172. package/quick-test-commands.md +0 -40
  173. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  174. package/recordings/mh-ls-22jul.txt +0 -2305
  175. package/screenshot.png +0 -0
  176. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  177. package/setup-database-v2.sql +0 -53
  178. package/setup-database.sql +0 -41
  179. package/test-auth-config.js +0 -17
  180. package/test-cache-bust.sh +0 -43
  181. package/test-docs/README.md +0 -39
  182. package/test-html/404.html +0 -115
  183. package/test-html/README.html +0 -172
  184. package/test-html/auth.js +0 -97
  185. package/test-html/css/notion-style.css +0 -2036
  186. package/test-html/index.html +0 -172
  187. package/test-html/js/auth.js +0 -97
  188. package/test-html/js/main.js +0 -1485
  189. package/test-html/login.html +0 -102
  190. package/test-html/logout.html +0 -18
  191. package/update-domain.sql +0 -9
  192. package/user-access-view.sql +0 -49
  193. package/user-management/README.md +0 -301
  194. package/user-management/add-users.sh +0 -776
  195. package/user-management/create-user.js +0 -65
  196. package/user-management/users.txt +0 -15
  197. package/view-all-users.sql +0 -40
  198. package/wru-auth-config.js +0 -17
package/html-static/vercel-cli-setup-guide.html DELETED
@@ -1,582 +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 provides comprehensive instructions for installing the Vercel CLI across different operating systems. While `@knowcode/doc-builder` handles most...">
7
- <title>Vercel CLI Setup Guide | @knowcode/doc-builder</title>
8
-
9
- <meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
10
- <meta name="author" content="Lindsay Smith">
11
- <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, cli, https">
12
- <meta name="robots" content="index, follow">
13
- <link rel="canonical" href="https://doc-builder-delta.vercel.app/vercel-cli-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/vercel-cli-setup-guide.html">
18
- <meta property="og:title" content="Vercel CLI Setup Guide | @knowcode/doc-builder">
19
- <meta property="og:description" content="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems. While `@knowcode/doc-builder` handles most...">
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="Vercel CLI Setup Guide | @knowcode/doc-builder">
29
- <meta name="twitter:description" content="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems. While `@knowcode/doc-builder` handles most...">
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": "Vercel CLI Setup Guide",
223
- "description": "This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems. While `@knowcode/doc-builder` handles most...",
224
- "author": {
225
- "@type": "Person",
226
- "name": "Lindsay Smith"
227
- },
228
- "publisher": {
229
- "@type": "Organization",
230
- "name": "Knowcode Ltd",
231
- "url": "https://knowcode.tech"
232
- },
233
- "datePublished": "2025-08-12T21:40:09.552Z",
234
- "dateModified": "2025-08-12T21:40:09.552Z",
235
- "mainEntityOfPage": {
236
- "@type": "WebPage",
237
- "@id": "https://doc-builder-delta.vercel.app/vercel-cli-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": "Vercel Cli Setup Guide",
252
- "item": "https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html"
253
- }
254
- ]
255
- }
256
- }
257
- </script>
258
- </head>
259
- <body>
260
-
261
-
262
-
263
-
264
- <!-- Breadcrumbs -->
265
- <nav class="breadcrumbs breadcrumbs-static" id="breadcrumbs" data-build-date="Aug 12, 2025, 09:40 PM UTC" data-doc-builder-version="1.9.29">
266
-
267
- <!-- Pre-rendered breadcrumb content for static builds -->
268
- <div class="breadcrumbs-content breadcrumbs-homepage">
269
- <div class="breadcrumbs-right">
270
- <span class="breadcrumb-date" title="Built with doc-builder v1.9.29">Last updated: Aug 12, 2025, 09:40 PM UTC</span>
271
- <button class="breadcrumb-pdf-btn" onclick="if(typeof exportToPDF !== 'undefined') exportToPDF(); else window.print();" title="Export to PDF" aria-label="Export to PDF">
272
- <i class="fas fa-file-pdf"></i>
273
- </button>
274
- </div>
275
- </div>
276
-
277
- </nav>
278
-
279
- <!-- Main Content -->
280
- <div class="main-wrapper">
281
- <!-- Sidebar -->
282
- <aside class="sidebar">
283
- <div class="sidebar-header">
284
- <div class="filter-box">
285
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
286
- <i class="fas fa-search filter-icon"></i>
287
- </div>
288
- </div>
289
- <nav class="navigation">
290
-
291
- <div class="nav-section" data-level="0">
292
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
293
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
294
- </a>
295
- <div class="nav-content">
296
- <a href="README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
297
- <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>
298
- <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>
299
- <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>
300
- <a href="vercel-cli-setup-guide.html" class="nav-item active" 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>
301
- <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>
302
- <div class="nav-section" data-level="1">
303
- <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
304
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
305
- </a>
306
- <div class="nav-content collapsed" id="nav-guides-1">
307
- <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>
308
- <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>
309
- <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>
310
- <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>
311
- <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>
312
- <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>
313
- <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>
314
- <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>
315
- <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>
316
- <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>
317
- <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>
318
- <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>
319
- <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>
320
- <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>
321
- <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>
322
- <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>
323
- <a href="guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Windows Setup Guide</a></div></div>
324
- <div class="nav-section" data-level="1">
325
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
326
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
327
- </a>
328
- <div class="nav-content collapsed" id="nav-prompts-1">
329
- <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>
330
- <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>
331
- <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>
332
- <div class="nav-section" data-level="1">
333
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
334
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
335
- </a>
336
- <div class="nav-content collapsed" id="nav-test-questions-1">
337
- <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>
338
- <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>
339
- <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>
340
- </nav>
341
- <div class="resize-handle"></div>
342
- </aside>
343
-
344
- <!-- Content Area -->
345
- <main class="content">
346
- <div class="content-inner">
347
- <h1>Vercel CLI Setup Guide</h1>
348
- <h2>Overview</h2>
349
- <p>This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems. While <code>@knowcode/doc-builder</code> handles most deployment complexity for you, understanding Vercel CLI installation and advanced features can be helpful for power users.</p>
350
- <h2>Prerequisites</h2>
351
- <ul>
352
- <li><strong>Node.js</strong>: Version 14.x or higher <i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i></li>
353
- <li><strong>npm</strong> or <strong>yarn</strong>: Package manager <i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i></li>
354
- <li><strong>Git</strong>: For version control (optional but recommended) <i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i></li>
355
- </ul>
356
- <h2>Installation Methods</h2>
357
- <h3>Method 1: npm (Recommended)</h3>
358
- <pre><code class="language-bash">npm install -g vercel
359
- </code></pre>
360
- <p><strong>Official Documentation</strong>: <a href="https://vercel.com/docs/cli#installing-vercel-cli">https://vercel.com/docs/cli#installing-vercel-cli</a></p>
361
- <h3>Method 2: yarn</h3>
362
- <pre><code class="language-bash">yarn global add vercel
363
- </code></pre>
364
- <h3>Method 3: pnpm</h3>
365
- <pre><code class="language-bash">pnpm add -g vercel
366
- </code></pre>
367
- <h3>Method 4: Homebrew (macOS/Linux)</h3>
368
- <pre><code class="language-bash">brew install vercel-cli
369
- </code></pre>
370
- <p><strong>Homebrew Formula</strong>: <a href="https://formulae.brew.sh/formula/vercel-cli">https://formulae.brew.sh/formula/vercel-cli</a></p>
371
- <h3>Method 5: Standalone Binary</h3>
372
- <p>Download directly from: <a href="https://vercel.com/download">https://vercel.com/download</a></p>
373
- <h2>Quick Start for doc-builder Users</h2>
374
- <p>If you&#39;re using <code>@knowcode/doc-builder</code>, you only need to:</p>
375
- <ol>
376
- <li><p><strong>Install Vercel CLI</strong> (if not already installed):</p>
377
- <pre><code class="language-bash">npm install -g vercel
378
- </code></pre>
379
- </li>
380
- <li><p><strong>Login to Vercel</strong> (one-time setup):</p>
381
- <pre><code class="language-bash">vercel login
382
- </code></pre>
383
- </li>
384
- <li><p><strong>Deploy with doc-builder</strong>:</p>
385
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
386
- </code></pre>
387
- </li>
388
- </ol>
389
- <p>That&#39;s it! doc-builder handles all the configuration for you.</p>
390
- <h2>Detailed Installation Instructions</h2>
391
- <h2>Understanding Vercel CLI</h2>
392
- <h3>What Gets Installed</h3>
393
- <p>The Vercel CLI stores configuration in:</p>
394
- <ul>
395
- <li><strong>macOS/Linux</strong>: <code>~/.vercel/</code></li>
396
- <li><strong>Windows</strong>: <code>%USERPROFILE%\.vercel\</code></li>
397
- </ul>
398
- <h3>Authentication</h3>
399
- <pre><code class="language-bash"># Check who you&#39;re logged in as
400
- vercel whoami
401
-
402
- # Log out
403
- vercel logout
404
-
405
- # Log in again
406
- vercel login
407
- </code></pre>
408
- <p><strong>Note</strong>: doc-builder automatically generates the necessary <code>vercel.json</code> configuration for you, so you don&#39;t need to create it manually.</p>
409
- <h2>Advanced Vercel CLI Commands</h2>
410
- <p>While doc-builder handles deployment, you might want to use these Vercel CLI commands directly:</p>
411
- <h3>Project Management</h3>
412
- <pre><code class="language-bash"># List your projects
413
- vercel project ls
414
-
415
- # View project details
416
- vercel project &lt;project-name&gt;
417
-
418
- # Remove a project
419
- vercel project rm &lt;project-name&gt;
420
- </code></pre>
421
- <h3>Domain Management</h3>
422
- <pre><code class="language-bash"># List domains
423
- vercel domains ls
424
-
425
- # Add a domain to a project
426
- vercel domains add &lt;domain&gt; &lt;project&gt;
427
-
428
- # Remove a domain
429
- vercel domains rm &lt;domain&gt;
430
- </code></pre>
431
- <h3>Deployment Management</h3>
432
- <pre><code class="language-bash"># List recent deployments
433
- vercel ls
434
-
435
- # Inspect a deployment
436
- vercel inspect &lt;deployment-url&gt;
437
-
438
- # Remove a deployment
439
- vercel rm &lt;deployment-url&gt;
440
- </code></pre>
441
- <h3>Environment Variables</h3>
442
- <pre><code class="language-bash"># Add environment variable
443
- vercel env add &lt;name&gt;
444
-
445
- # List environment variables
446
- vercel env ls
447
-
448
- # Remove environment variable
449
- vercel env rm &lt;name&gt;
450
- </code></pre>
451
- <h2>Troubleshooting</h2>
452
- <h3>Common Installation Issues</h3>
453
- <h4>Command Not Found</h4>
454
- <p>If <code>vercel</code> command is not found after installation:</p>
455
- <pre><code class="language-bash"># Find npm global bin location
456
- npm bin -g
457
-
458
- # Add to PATH (add to your ~/.bashrc or ~/.zshrc)
459
- export PATH=&quot;$(npm bin -g):$PATH&quot;
460
- </code></pre>
461
- <h4>Permission Errors</h4>
462
- <p>If you get EACCES errors during installation:</p>
463
- <pre><code class="language-bash"># Option 1: Use npx instead (recommended)
464
- npx vercel
465
-
466
- # Option 2: Fix npm permissions
467
- # See: https://docs.npmjs.com/resolving-eacces-permissions-errors
468
-
469
- # Option 3: Use a Node version manager like nvm
470
- # See: https://github.com/nvm-sh/nvm
471
- </code></pre>
472
- <h4>Authentication Issues</h4>
473
- <pre><code class="language-bash"># If login fails, try:
474
- vercel logout
475
- vercel login
476
-
477
- # For corporate proxies:
478
- export HTTP_PROXY=http://proxy.company.com:8080
479
- export HTTPS_PROXY=http://proxy.company.com:8080
480
- </code></pre>
481
- <h2>Platform-Specific Instructions</h2>
482
- <h3>macOS</h3>
483
- <ol>
484
- <li><p><strong>Install via Homebrew</strong> (recommended):</p>
485
- <pre><code class="language-bash">brew install vercel-cli
486
- </code></pre>
487
- </li>
488
- <li><p><strong>Verify Xcode Command Line Tools</strong>:</p>
489
- <pre><code class="language-bash">xcode-select --install
490
- </code></pre>
491
- </li>
492
- </ol>
493
- <p><strong>macOS Guide</strong>: <a href="https://vercel.com/docs/cli#macos-installation">https://vercel.com/docs/cli#macos-installation</a></p>
494
- <h3>Windows</h3>
495
- <ol>
496
- <li><p><strong>Install Node.js</strong> from <a href="https://nodejs.org/">https://nodejs.org/</a></p>
497
- </li>
498
- <li><p><strong>Use PowerShell as Administrator</strong>:</p>
499
- <pre><code class="language-powershell">npm install -g vercel
500
- </code></pre>
501
- </li>
502
- <li><p><strong>Windows-specific issues</strong>: <a href="https://vercel.com/docs/cli#windows-installation">https://vercel.com/docs/cli#windows-installation</a></p>
503
- </li>
504
- </ol>
505
- <h3>Linux</h3>
506
- <ol>
507
- <li><p><strong>Install Node.js via package manager</strong>:</p>
508
- <pre><code class="language-bash"># Ubuntu/Debian
509
- sudo apt update
510
- sudo apt install nodejs npm
511
-
512
- # Fedora
513
- sudo dnf install nodejs npm
514
-
515
- # Arch
516
- sudo pacman -S nodejs npm
517
- </code></pre>
518
- </li>
519
- <li><p><strong>Install Vercel CLI</strong>:</p>
520
- <pre><code class="language-bash">sudo npm install -g vercel
521
- </code></pre>
522
- </li>
523
- </ol>
524
- <p><strong>Linux Guide</strong>: <a href="https://vercel.com/docs/cli#linux-installation">https://vercel.com/docs/cli#linux-installation</a></p>
525
- <h2>Using Vercel CLI with doc-builder</h2>
526
- <h3>Deploying to Production</h3>
527
- <p>While doc-builder handles deployment, you can also use Vercel CLI directly:</p>
528
- <pre><code class="language-bash"># From your html output directory
529
- cd html
530
- vercel --prod
531
- </code></pre>
532
- <h3>Working with Teams</h3>
533
- <pre><code class="language-bash"># Switch between personal and team accounts
534
- vercel switch
535
-
536
- # Deploy to a specific team
537
- vercel --scope team-name
538
- </code></pre>
539
- <h3>CI/CD Integration</h3>
540
- <p>For automated deployments:</p>
541
- <pre><code class="language-yaml"># GitHub Actions example
542
- - name: Deploy Documentation
543
- run: |
544
- npm install -g @knowcode/doc-builder@latest vercel
545
- doc-builder build
546
- vercel --prod --token=${{ secrets.VERCEL_TOKEN }}
547
- </code></pre>
548
- <h2>Key Resources</h2>
549
- <h3>Official Documentation</h3>
550
- <ul>
551
- <li><strong>Vercel CLI Docs</strong>: <a href="https://vercel.com/docs/cli">https://vercel.com/docs/cli</a></li>
552
- <li><strong>Vercel Dashboard</strong>: <a href="https://vercel.com/dashboard">https://vercel.com/dashboard</a></li>
553
- <li><strong>Support</strong>: <a href="https://vercel.com/support">https://vercel.com/support</a></li>
554
- </ul>
555
- <h3>For doc-builder Users</h3>
556
- <ul>
557
- <li><strong>First-Time Setup Guide</strong>: <a href="./vercel-first-time-setup-guide.md">vercel-first-time-setup-guide.md</a></li>
558
- <li><strong>Troubleshooting Guide</strong>: <a href="./troubleshooting-guide.md">troubleshooting-guide.md</a></li>
559
- <li><strong>doc-builder Documentation</strong>: <a href="https://www.npmjs.com/package/@knowcode/doc-builder">https://www.npmjs.com/package/@knowcode/doc-builder</a></li>
560
- </ul>
561
- <hr>
562
- <p>This guide covers Vercel CLI installation and advanced usage. For most doc-builder users, the simplified deployment process handles everything automatically. See the <a href="./vercel-first-time-setup-guide.md">First-Time Setup Guide</a> for the streamlined deployment experience.</p>
563
-
564
- </div>
565
- </main>
566
- </div>
567
-
568
- <!-- Scripts -->
569
- <script>
570
- // Pass configuration to frontend
571
- window.docBuilderConfig = {
572
- features: {
573
- showPdfDownload: true,
574
- menuDefaultOpen: false,
575
- mermaidEnhanced: true
576
- }
577
- };
578
- </script>
579
- <script src="js/main.js"></script>
580
-
581
- </body>
582
- </html>