@knowcode/doc-builder 1.9.29 → 1.9.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. package/assets/js/main.js +7 -0
  2. package/lib/core-builder.js +18 -1
  3. package/package.json +12 -2
  4. package/.claude/settings.local.json +0 -56
  5. package/CACHE-BUSTING-GUIDE.md +0 -82
  6. package/CLAUDE.md +0 -86
  7. package/CONTRIBUTING.md +0 -148
  8. package/GITHUB_SETUP.md +0 -203
  9. package/RELEASE-NOTES-1.7.5.md +0 -64
  10. package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
  11. package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
  12. package/add-user-clive.sql +0 -35
  13. package/add-user-lindsay-fixed.sql +0 -85
  14. package/add-user-lindsay.sql +0 -68
  15. package/add-user-pmorgan.sql +0 -35
  16. package/add-user-robbie.sql +0 -35
  17. package/add-wru-users.sql +0 -105
  18. package/debug-login.sql +0 -30
  19. package/doc-builder.config.js +0 -126
  20. package/doc-builder.config.js.backup.1753793768283 +0 -47
  21. package/doc-builder.config.js.backup.1753803964423 +0 -114
  22. package/doc-builder.config.js.backup.1753945707032 +0 -115
  23. package/doc-builder.config.js.backup.1754059241330 +0 -115
  24. package/doc-builder.config.js.backup.1754119567787 +0 -123
  25. package/doc-builder.config.js.backup.1754120048862 +0 -124
  26. package/doc-builder.config.js.backup.1754120529913 +0 -124
  27. package/doc-builder.config.js.backup.1754218469785 +0 -124
  28. package/doc-builder.config.js.backup.1754384764054 +0 -124
  29. package/doc-builder.config.js.backup.1754567425847 +0 -124
  30. package/doc-builder.config.js.backup.1754568137859 +0 -126
  31. package/doc-builder.config.js.backup.1754569388252 +0 -126
  32. package/doc-builder.config.js.backup.1754576694123 +0 -126
  33. package/doc-builder.config.js.backup.1755031374829 +0 -126
  34. package/doc-builder.config.js.backup.1755034500990 +0 -126
  35. package/grant-access.sql +0 -15
  36. package/html/11.png +0 -0
  37. package/html/404.html +0 -115
  38. package/html/README.html +0 -522
  39. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  40. package/html/about-doc-builder.html +0 -491
  41. package/html/auth.js +0 -157
  42. package/html/claude-workflow-guide.html +0 -525
  43. package/html/css/notion-style.css +0 -2502
  44. package/html/documentation-index.html +0 -471
  45. package/html/guides/authentication-default-change.html +0 -370
  46. package/html/guides/authentication-guide.html +0 -509
  47. package/html/guides/cache-control-anti-pattern.html +0 -361
  48. package/html/guides/claude-workflow-guide.html +0 -1074
  49. package/html/guides/configuration-guide.html +0 -472
  50. package/html/guides/document-standards.html +0 -518
  51. package/html/guides/documentation-standards.html +0 -694
  52. package/html/guides/html-embedding-guide.html +0 -461
  53. package/html/guides/image-modal-guide.html +0 -515
  54. package/html/guides/next-steps-walkthrough.html +0 -638
  55. package/html/guides/phosphor-icons-guide.html +0 -584
  56. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  57. package/html/guides/private-directory-authentication.html +0 -541
  58. package/html/guides/public-site-deployment.html +0 -431
  59. package/html/guides/search-engine-verification-guide.html +0 -542
  60. package/html/guides/seo-guide.html +0 -661
  61. package/html/guides/seo-optimization-guide.html +0 -887
  62. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  63. package/html/guides/supabase-auth-integration-plan.html +0 -671
  64. package/html/guides/supabase-auth-setup-guide.html +0 -498
  65. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  66. package/html/guides/troubleshooting-guide.html +0 -633
  67. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  68. package/html/guides/windows-setup-guide.html +0 -859
  69. package/html/image-modal-test.html +0 -318
  70. package/html/index.html +0 -522
  71. package/html/js/auth.js +0 -157
  72. package/html/js/main.js +0 -1747
  73. package/html/launch/README.html +0 -297
  74. package/html/launch/bubble-plugin-specification.html +0 -933
  75. package/html/launch/go-to-market-strategy.html +0 -663
  76. package/html/launch/launch-announcements.html +0 -593
  77. package/html/login.html +0 -102
  78. package/html/logout.html +0 -18
  79. package/html/private/cache-control-anti-pattern.html +0 -429
  80. package/html/private/launch/README.html +0 -371
  81. package/html/private/launch/auth-cleanup-summary.html +0 -361
  82. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  83. package/html/private/launch/go-to-market-strategy.html +0 -737
  84. package/html/private/launch/launch-announcements.html +0 -667
  85. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  86. package/html/private/next-steps-walkthrough.html +0 -679
  87. package/html/private/supabase-auth-implementation-completed.html +0 -454
  88. package/html/private/supabase-auth-implementation-plan.html +0 -594
  89. package/html/private/supabase-auth-integration-plan.html +0 -704
  90. package/html/private/supabase-auth-setup-guide.html +0 -555
  91. package/html/private/test-private-doc.html +0 -302
  92. package/html/private/user-management-tooling.html +0 -601
  93. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  94. package/html/prompts/beautiful-documentation-design.html +0 -784
  95. package/html/prompts/markdown-document-standards.html +0 -422
  96. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  97. package/html/robots.txt +0 -9
  98. package/html/sitemap.xml +0 -357
  99. package/html/test-questions/how-does-it-work%3F.html +0 -294
  100. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  101. package/html/test-questions/what-is-the-purpose.html +0 -293
  102. package/html/test-status.html +0 -281
  103. package/html/vercel-cli-setup-guide.html +0 -495
  104. package/html/vercel-first-time-setup-guide.html +0 -454
  105. package/html/vercel.json +0 -29
  106. package/html-static/11.png +0 -0
  107. package/html-static/404.html +0 -115
  108. package/html-static/README.html +0 -599
  109. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  110. package/html-static/about-doc-builder.html +0 -568
  111. package/html-static/css/notion-style.css +0 -2502
  112. package/html-static/documentation-index.html +0 -548
  113. package/html-static/guides/authentication-default-change.html +0 -447
  114. package/html-static/guides/authentication-guide.html +0 -586
  115. package/html-static/guides/claude-workflow-guide.html +0 -1151
  116. package/html-static/guides/configuration-guide.html +0 -549
  117. package/html-static/guides/documentation-standards.html +0 -771
  118. package/html-static/guides/html-embedding-guide.html +0 -538
  119. package/html-static/guides/image-modal-guide.html +0 -592
  120. package/html-static/guides/phosphor-icons-guide.html +0 -661
  121. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -632
  122. package/html-static/guides/private-directory-authentication.html +0 -618
  123. package/html-static/guides/public-site-deployment.html +0 -508
  124. package/html-static/guides/search-engine-verification-guide.html +0 -619
  125. package/html-static/guides/seo-guide.html +0 -738
  126. package/html-static/guides/seo-optimization-guide.html +0 -964
  127. package/html-static/guides/supabase-authentication-complete-guide.html +0 -943
  128. package/html-static/guides/troubleshooting-guide.html +0 -710
  129. package/html-static/guides/windows-setup-guide.html +0 -936
  130. package/html-static/image-modal-test.html +0 -395
  131. package/html-static/index.html +0 -599
  132. package/html-static/js/main.js +0 -1747
  133. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  134. package/html-static/prompts/beautiful-documentation-design.html +0 -861
  135. package/html-static/prompts/markdown-document-standards.html +0 -499
  136. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -607
  137. package/html-static/robots.txt +0 -5
  138. package/html-static/sitemap.xml +0 -195
  139. package/html-static/test-questions/how-does-it-work%3F.html +0 -371
  140. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -366
  141. package/html-static/test-questions/what-is-the-purpose.html +0 -370
  142. package/html-static/vercel-cli-setup-guide.html +0 -572
  143. package/html-static/vercel-first-time-setup-guide.html +0 -531
  144. package/manage-users.sql +0 -191
  145. package/migrate-to-domain-auth.sql +0 -47
  146. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  147. package/package/CHANGELOG.md +0 -902
  148. package/package/README.md +0 -248
  149. package/package/assets/css/notion-style.css +0 -2211
  150. package/package/assets/js/auth.js +0 -67
  151. package/package/assets/js/main.js +0 -1565
  152. package/package/cli.js +0 -764
  153. package/package/index.js +0 -38
  154. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  155. package/package/lib/builder.js +0 -32
  156. package/package/lib/config.js +0 -278
  157. package/package/lib/core-builder.js +0 -957
  158. package/package/lib/deploy.js +0 -497
  159. package/package/lib/dev-server.js +0 -96
  160. package/package/package.json +0 -34
  161. package/package/scripts/npx-runner.js +0 -27
  162. package/package/scripts/setup.js +0 -56
  163. package/package/test-cache-bust.sh +0 -43
  164. package/public-config.js +0 -22
  165. package/public-html/404.html +0 -115
  166. package/public-html/README.html +0 -149
  167. package/public-html/css/notion-style.css +0 -2036
  168. package/public-html/index.html +0 -149
  169. package/public-html/js/auth.js +0 -67
  170. package/public-html/js/main.js +0 -1485
  171. package/quick-test-commands.md +0 -40
  172. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  173. package/recordings/mh-ls-22jul.txt +0 -2305
  174. package/screenshot.png +0 -0
  175. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  176. package/setup-database-v2.sql +0 -53
  177. package/setup-database.sql +0 -41
  178. package/test-auth-config.js +0 -17
  179. package/test-cache-bust.sh +0 -43
  180. package/test-docs/README.md +0 -39
  181. package/test-html/404.html +0 -115
  182. package/test-html/README.html +0 -172
  183. package/test-html/auth.js +0 -97
  184. package/test-html/css/notion-style.css +0 -2036
  185. package/test-html/index.html +0 -172
  186. package/test-html/js/auth.js +0 -97
  187. package/test-html/js/main.js +0 -1485
  188. package/test-html/login.html +0 -102
  189. package/test-html/logout.html +0 -18
  190. package/update-domain.sql +0 -9
  191. package/user-access-view.sql +0 -49
  192. package/user-management/README.md +0 -301
  193. package/user-management/add-users.sh +0 -776
  194. package/user-management/create-user.js +0 -65
  195. package/user-management/users.txt +0 -15
  196. package/view-all-users.sql +0 -40
  197. package/wru-auth-config.js +0 -17
@@ -1,454 +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 walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
7
- <title>Vercel First-Time 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, your, deployment">
12
- <meta name="robots" content="index, follow">
13
- <link rel="canonical" href="https://doc-builder-delta.vercel.app/vercel-first-time-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-first-time-setup-guide.html">
18
- <meta property="og:title" content="Vercel First-Time Setup Guide | @knowcode/doc-builder">
19
- <meta property="og:description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
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 First-Time Setup Guide | @knowcode/doc-builder">
29
- <meta name="twitter:description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
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": "Vercel First-Time Setup Guide",
94
- "description": "This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.",
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:35:01.208Z",
105
- "dateModified": "2025-08-12T21:35:01.208Z",
106
- "mainEntityOfPage": {
107
- "@type": "WebPage",
108
- "@id": "https://doc-builder-delta.vercel.app/vercel-first-time-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": "Vercel First Time Setup Guide",
123
- "item": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html"
124
- }
125
- ]
126
- }
127
- }
128
- </script>
129
- </head>
130
- <body>
131
-
132
- <!-- Header -->
133
- <header class="header">
134
- <div class="header-content">
135
- <a href="/index.html" class="logo">@knowcode/doc-builder</a>
136
-
137
- <div class="header-actions">
138
- <div class="deployment-info">
139
- <span class="deployment-date" title="Built with doc-builder v1.9.28">Last updated: Aug 12, 2025, 09:35 PM UTC</span>
140
- </div>
141
-
142
-
143
- <a href="../login.html" class="auth-btn" title="Login/Logout">
144
- <i class="fas fa-sign-in-alt"></i>
145
- </a>
146
-
147
-
148
- <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
149
- <i class="fas fa-moon"></i>
150
- </button>
151
-
152
- <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
153
- <i class="fas fa-bars"></i>
154
- </button>
155
- </div>
156
- </div>
157
- </header>
158
-
159
-
160
-
161
-
162
- <!-- Breadcrumbs -->
163
- <nav class="breadcrumbs " id="breadcrumbs" >
164
- <!-- Breadcrumbs will be generated by JavaScript -->
165
- </nav>
166
-
167
- <!-- Main Content -->
168
- <div class="main-wrapper">
169
- <!-- Sidebar -->
170
- <aside class="sidebar">
171
- <div class="sidebar-header">
172
- <div class="filter-box">
173
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
174
- <i class="fas fa-search filter-icon"></i>
175
- </div>
176
- </div>
177
- <nav class="navigation">
178
-
179
- <div class="nav-section" data-level="0">
180
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
181
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
182
- </a>
183
- <div class="nav-content">
184
- <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
185
- <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>
186
- <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>
187
- <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>
188
- <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>
189
- <a href="/vercel-first-time-setup-guide.html" class="nav-item active" 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>
190
- <div class="nav-section" data-level="1">
191
- <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
192
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
193
- </a>
194
- <div class="nav-content collapsed" id="nav-guides-1">
195
- <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>
196
- <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>
197
- <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>
198
- <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>
199
- <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>
200
- <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>
201
- <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>
202
- <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>
203
- <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>
204
- <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>
205
- <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>
206
- <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>
207
- <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>
208
- <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>
209
- <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>
210
- <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>
211
- <a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
212
- <div class="nav-section private-nav" data-level="1">
213
- <a class="nav-title collapsible" href="#" data-target="nav-private-1" >
214
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-lock"></i> Private
215
- </a>
216
- <div class="nav-content collapsed" id="nav-private-1">
217
- <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>
218
- <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>
219
- <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>
220
- <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>
221
- <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>
222
- <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>
223
- <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>
224
- <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>
225
- <div class="nav-section private-nav" data-level="2">
226
- <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
227
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-rocket-launch"></i> Launch
228
- </a>
229
- <div class="nav-content collapsed" id="nav-private-launch-2">
230
- <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>
231
- <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>
232
- <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>
233
- <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>
234
- <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>
235
- <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>
236
- <div class="nav-section" data-level="1">
237
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
238
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
239
- </a>
240
- <div class="nav-content collapsed" id="nav-prompts-1">
241
- <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>
242
- <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>
243
- <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>
244
- <div class="nav-section" data-level="1">
245
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
246
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
247
- </a>
248
- <div class="nav-content collapsed" id="nav-test-questions-1">
249
- <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>
250
- <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>
251
- <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>
252
- </nav>
253
- <div class="resize-handle"></div>
254
- </aside>
255
-
256
- <!-- Content Area -->
257
- <main class="content">
258
- <div class="content-inner">
259
- <h1>Vercel First-Time Setup Guide</h1>
260
- <h2>Overview</h2>
261
- <p>This guide walks you through the Vercel deployment process when using <code>@knowcode/doc-builder deploy</code>.</p>
262
- <h2>The Deployment Process</h2>
263
- <h3>Step 1: Run the Deploy Command</h3>
264
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
265
- </code></pre>
266
- <h3>Step 2: doc-builder Configuration</h3>
267
- <p>The tool will ask a few simple questions:</p>
268
- <h4>Project Name</h4>
269
- <pre><code>? What is your project name? › my-docs
270
- </code></pre>
271
- <ul>
272
- <li>This becomes your Vercel project identifier</li>
273
- <li>Will be part of your URL: <code>project-name.vercel.app</code></li>
274
- <li>Use lowercase letters, numbers, and hyphens only</li>
275
- </ul>
276
- <h4>Custom Production URL (Optional)</h4>
277
- <pre><code>? Custom production URL (optional)? ›
278
- </code></pre>
279
- <ul>
280
- <li>Press Enter to skip (recommended for first-time setup)</li>
281
- <li>Or enter your custom domain if you have one</li>
282
- </ul>
283
- <h3>Step 3: Vercel CLI Takes Over</h3>
284
- <p>The Vercel CLI will guide you through the following prompts:</p>
285
- <h4>Deploy Confirmation</h4>
286
- <pre><code>Vercel CLI 28.0.0
287
- ? Set up and deploy &quot;~/path/to/your/project/html&quot;? [Y/n]
288
- </code></pre>
289
- <ul>
290
- <li>Answer <strong>Yes</strong> to proceed</li>
291
- <li>This confirms you want to deploy the current directory</li>
292
- </ul>
293
- <h4>Account Selection</h4>
294
- <pre><code>? Which scope do you want to deploy to? ›
295
- ○ Your Name
296
- ○ Your Team (if applicable)
297
- </code></pre>
298
- <ul>
299
- <li>Select your personal account or team</li>
300
- <li>Use arrow keys to navigate, Enter to select</li>
301
- </ul>
302
- <h4>Project Name Confirmation</h4>
303
- <pre><code>? What&#39;s your project&#39;s name? (my-docs)
304
- </code></pre>
305
- <ul>
306
- <li>Vercel suggests the name you provided earlier</li>
307
- <li>Press Enter to accept or type a new name</li>
308
- </ul>
309
- <h4>Framework Detection</h4>
310
- <pre><code>? In which directory is your code located? ./
311
- </code></pre>
312
- <ul>
313
- <li>Vercel automatically detects this is a static site</li>
314
- <li>Usually defaults to <code>./</code> which is correct</li>
315
- <li>Press Enter to accept</li>
316
- </ul>
317
- <h3>Step 4: Deployment Begins</h3>
318
- <p>That&#39;s it! Vercel will now:</p>
319
- <ol>
320
- <li>Upload your files</li>
321
- <li>Deploy to their global CDN</li>
322
- <li>Provide your live URL</li>
323
- </ol>
324
- <pre><code>✓ Production: https://my-docs.vercel.app [copied to clipboard]
325
- </code></pre>
326
- <h2>Post-Deployment Configuration</h2>
327
- <h3>Making Your Docs Public</h3>
328
- <p>By default, Vercel may protect your deployment. To make docs publicly accessible:</p>
329
- <ol>
330
- <li>Go to your <a href="https://vercel.com/dashboard">Vercel Dashboard</a></li>
331
- <li>Click on your project</li>
332
- <li>Navigate to <strong>Settings → Deployment Protection</strong></li>
333
- <li>Set <strong>Vercel Authentication</strong> to <strong>Disabled</strong></li>
334
- <li>Click <strong>Save</strong></li>
335
- </ol>
336
- <h3>SEO Optimization</h3>
337
- <p>Once deployed, optimize your documentation for search engines:</p>
338
- <ol>
339
- <li><p><strong>Check SEO Status</strong>:</p>
340
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest seo-check
341
- </code></pre>
342
- </li>
343
- <li><p><strong>Configure SEO Settings</strong>:</p>
344
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest setup-seo
345
- </code></pre>
346
- </li>
347
- <li><p><strong>Review the SEO Guide</strong>: See our comprehensive <a href="./guides/seo-optimization-guide.md">SEO Optimization Guide</a> for best practices</p>
348
- </li>
349
- </ol>
350
- <h3>Google Search Console Setup</h3>
351
- <p>Make your documentation discoverable on Google:</p>
352
- <ol>
353
- <li><p><strong>Add Verification</strong>:</p>
354
- <pre><code class="language-bash">npx @knowcode/doc-builder@latest google-verify YOUR_VERIFICATION_CODE
355
- </code></pre>
356
- </li>
357
- <li><p><strong>Submit Sitemap</strong>: </p>
358
- <ul>
359
- <li>Your sitemap is automatically generated at <code>/sitemap.xml</code></li>
360
- <li>Submit it in Google Search Console</li>
361
- </ul>
362
- </li>
363
- <li><p><strong>Full Instructions</strong>: See the <a href="./guides/search-engine-verification-guide.md">Search Engine Verification Guide</a></p>
364
- </li>
365
- </ol>
366
- <h3>Custom Domain (Optional)</h3>
367
- <p>To add a custom domain:</p>
368
- <ol>
369
- <li>Go to <strong>Settings → Domains</strong></li>
370
- <li>Add your domain</li>
371
- <li>Follow DNS configuration instructions</li>
372
- <li>Update your sitemap URL in Google Search Console</li>
373
- </ol>
374
- <h3>Environment Variables (If Using Authentication)</h3>
375
- <p>If you enabled authentication in doc-builder:</p>
376
- <ol>
377
- <li>Go to <strong>Settings → Environment Variables</strong></li>
378
- <li>Add your auth credentials</li>
379
- <li>Redeploy to apply changes</li>
380
- </ol>
381
- <h2>Troubleshooting</h2>
382
- <h3>&quot;Vercel CLI not found&quot;</h3>
383
- <p>If you see this error, install Vercel CLI:</p>
384
- <pre><code class="language-bash">npm install -g vercel
385
- </code></pre>
386
- <h3>&quot;404 Not Found&quot; After Deployment</h3>
387
- <p>Make sure you:</p>
388
- <ol>
389
- <li>Ran the deploy command from your project root</li>
390
- <li>Have markdown files in your <code>docs/</code> folder</li>
391
- <li>Didn&#39;t modify the build output</li>
392
- </ol>
393
- <h3>&quot;Authentication Required&quot; Error</h3>
394
- <p>Your deployment is protected. Follow the &quot;Making Your Docs Public&quot; steps above.</p>
395
- <h3>Deployment Fails</h3>
396
- <p>Check that:</p>
397
- <ol>
398
- <li>You&#39;re using the latest version: <code>npx @knowcode/doc-builder@latest deploy</code></li>
399
- <li>Your <code>docs/</code> folder contains <code>.md</code> files</li>
400
- <li>You have internet connection</li>
401
- </ol>
402
- <h2>Quick Checklist</h2>
403
- <pre><code>✅ 1. Run: npx @knowcode/doc-builder@latest deploy
404
- ✅ 2. Enter project name (e.g., my-docs)
405
- ✅ 3. Skip custom URL (press Enter)
406
- ✅ 4. Confirm deployment when Vercel asks
407
- ✅ 5. Select your account/scope
408
- ✅ 6. Accept suggested project name
409
- ✅ 7. Get your live URL!
410
- </code></pre>
411
- <h2>Best Practices</h2>
412
- <ol>
413
- <li><strong>First Time</strong>: Just accept all defaults</li>
414
- <li><strong>Project Names</strong>: Use descriptive names like <code>company-api-docs</code></li>
415
- <li><strong>Custom Domains</strong>: Add them after successful deployment</li>
416
- <li><strong>Updates</strong>: Future deploys are even simpler - just run the same command</li>
417
- </ol>
418
- <h2>Next Steps</h2>
419
- <p>After successful deployment:</p>
420
- <ol>
421
- <li>Visit your live docs at the provided URL</li>
422
- <li>Make your docs public in Vercel settings if needed</li>
423
- <li>Add a custom domain if desired</li>
424
- <li>Share your documentation with the world!</li>
425
- </ol>
426
- <h2>Getting Help</h2>
427
- <ul>
428
- <li><strong>Vercel Dashboard</strong>: <a href="https://vercel.com/dashboard">https://vercel.com/dashboard</a></li>
429
- <li><strong>Vercel Support</strong>: <a href="https://vercel.com/support">https://vercel.com/support</a></li>
430
- <li><strong>doc-builder Issues</strong>: File on GitHub or npm</li>
431
- </ul>
432
- <hr>
433
- <p>For additional Vercel CLI configuration options, see the <a href="./vercel-cli-setup-guide.md">Vercel CLI Setup Guide</a>.</p>
434
-
435
- </div>
436
- </main>
437
- </div>
438
-
439
- <!-- Scripts -->
440
- <script>
441
- // Pass configuration to frontend
442
- window.docBuilderConfig = {
443
- features: {
444
- showPdfDownload: true,
445
- menuDefaultOpen: false,
446
- mermaidEnhanced: true
447
- }
448
- };
449
- </script>
450
- <script src="/js/main.js"></script>
451
- <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
452
- <script src="/js/auth.js"></script>
453
- </body>
454
- </html>
package/html/vercel.json DELETED
@@ -1,29 +0,0 @@
1
- {
2
- "buildCommand": "",
3
- "outputDirectory": ".",
4
- "devCommand": "",
5
- "installCommand": "",
6
- "framework": null,
7
- "cleanUrls": true,
8
- "trailingSlash": false,
9
- "headers": [
10
- {
11
- "source": "/css/(.*)",
12
- "headers": [
13
- {
14
- "key": "Cache-Control",
15
- "value": "public, max-age=31536000, immutable"
16
- }
17
- ]
18
- },
19
- {
20
- "source": "/js/(.*)",
21
- "headers": [
22
- {
23
- "key": "Cache-Control",
24
- "value": "public, max-age=31536000, immutable"
25
- }
26
- ]
27
- }
28
- ]
29
- }
Binary file
@@ -1,115 +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
- <title>Page Not Found - Redirecting...</title>
7
- <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
8
- <style>
9
- body {
10
- font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
11
- margin: 0;
12
- padding: 0;
13
- display: flex;
14
- align-items: center;
15
- justify-content: center;
16
- min-height: 100vh;
17
- background-color: #f7f7f5;
18
- color: #37352f;
19
- }
20
- .container {
21
- text-align: center;
22
- padding: 2rem;
23
- max-width: 600px;
24
- }
25
- h1 {
26
- font-size: 3rem;
27
- margin: 0 0 1rem 0;
28
- color: #37352f;
29
- }
30
- p {
31
- font-size: 1.125rem;
32
- line-height: 1.6;
33
- color: #6b6b6b;
34
- margin: 0 0 2rem 0;
35
- }
36
- a {
37
- color: #0366d6;
38
- text-decoration: none;
39
- }
40
- a:hover {
41
- text-decoration: underline;
42
- }
43
- .emoji {
44
- font-size: 4rem;
45
- margin-bottom: 1rem;
46
- }
47
- .loading {
48
- display: none;
49
- color: #0366d6;
50
- margin-top: 1rem;
51
- }
52
- .redirect-message {
53
- display: none;
54
- background-color: #e8f4fd;
55
- border: 1px solid #c3e0f7;
56
- padding: 1rem;
57
- border-radius: 8px;
58
- margin-top: 1rem;
59
- }
60
- </style>
61
- </head>
62
- <body>
63
- <div class="container">
64
- <div class="emoji">🔍</div>
65
- <h1>404</h1>
66
- <p id="message">The page you're looking for doesn't exist.</p>
67
- <div id="redirect-message" class="redirect-message">
68
- Redirecting to the correct page...
69
- </div>
70
- <p id="loading" class="loading">Redirecting...</p>
71
- <p>
72
- <a href="/" id="home-link">Go to Home</a>
73
- </p>
74
- </div>
75
-
76
- <script>
77
- // Check if the URL ends with .md
78
- const pathname = window.location.pathname;
79
-
80
- if (pathname.endsWith('.md')) {
81
- // Convert .md to .html
82
- const htmlPath = pathname.replace(/\.md$/, '.html');
83
-
84
- // Show redirect message
85
- document.getElementById('message').textContent = 'Found a markdown link. Redirecting to the HTML version...';
86
- document.getElementById('redirect-message').style.display = 'block';
87
- document.getElementById('loading').style.display = 'block';
88
-
89
- // Redirect after a brief delay to show the message
90
- setTimeout(() => {
91
- window.location.replace(htmlPath);
92
- }, 500);
93
- } else {
94
- // For true 404s, show the standard message
95
- document.getElementById('message').textContent = "The page you're looking for doesn't exist.";
96
-
97
- // Also check if we can suggest a similar page
98
- // Remove common suffixes and try to find a match
99
- const basePath = pathname
100
- .replace(/\.(html|htm|php|asp|aspx)$/, '')
101
- .replace(/\/$/, '');
102
-
103
- if (basePath && basePath !== pathname) {
104
- document.getElementById('message').innerHTML =
105
- `The page you're looking for doesn't exist.<br>
106
- <small>Did you mean <a href="${basePath}.html">${basePath}.html</a>?</small>`;
107
- }
108
- }
109
-
110
- // Update home link to use the correct base URL
111
- const baseUrl = window.location.origin;
112
- document.getElementById('home-link').href = baseUrl;
113
- </script>
114
- </body>
115
- </html>