@knowcode/doc-builder 1.8.7 → 1.9.1
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.
- package/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +27 -0
- package/README.md +2 -0
- package/assets/css/notion-style.css +141 -0
- package/assets/js/main.js +76 -0
- package/html/README.html +41 -149
- package/html/css/notion-style.css +13 -253
- package/html/documentation-index.html +24 -127
- package/html/guides/authentication-default-change.html +15 -130
- package/html/guides/authentication-guide.html +27 -141
- package/html/guides/claude-workflow-guide.html +30 -137
- package/html/guides/documentation-standards.html +19 -133
- package/html/guides/image-modal-guide.html +381 -0
- package/html/guides/phosphor-icons-guide.html +35 -150
- package/html/guides/private-directory-authentication.html +15 -130
- package/html/guides/public-site-deployment.html +15 -130
- package/html/guides/search-engine-verification-guide.html +15 -130
- package/html/guides/seo-guide.html +15 -130
- package/html/guides/seo-optimization-guide.html +46 -159
- package/html/guides/troubleshooting-guide.html +27 -141
- package/html/guides/windows-setup-guide.html +46 -161
- package/html/image-modal-test.html +189 -0
- package/html/index.html +41 -149
- package/html/js/auth.js +39 -118
- package/html/js/main.js +25 -183
- package/html/private/cache-control-anti-pattern.html +20 -135
- package/html/private/launch/README.html +23 -144
- package/html/private/launch/auth-cleanup-summary.html +32 -153
- package/html/private/launch/bubble-plugin-specification.html +15 -136
- package/html/private/launch/go-to-market-strategy.html +17 -138
- package/html/private/launch/launch-announcements.html +31 -151
- package/html/private/launch/vercel-deployment-auth-setup.html +17 -138
- package/html/private/next-steps-walkthrough.html +21 -136
- package/html/private/supabase-auth-implementation-completed.html +29 -143
- package/html/private/supabase-auth-implementation-plan.html +22 -136
- package/html/private/supabase-auth-integration-plan.html +29 -142
- package/html/private/supabase-auth-setup-guide.html +24 -139
- package/html/private/test-private-doc.html +15 -130
- package/html/private/user-management-tooling.html +15 -130
- package/html/prompts/markdown-document-standards.html +288 -0
- package/html/sitemap.xml +56 -44
- package/html/vercel-cli-setup-guide.html +19 -128
- package/html/vercel-first-time-setup-guide.html +16 -125
- package/lib/core-builder.js +1 -0
- package/lib/emoji-mapper.js +25 -0
- package/package/assets/css/notion-style.css +432 -135
- package/package/assets/js/main.js +259 -25
- package/package.json +1 -1
|
@@ -3,41 +3,14 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
7
|
-
<title>Windows Setup Guide for Claude Code &
|
|
8
|
-
|
|
9
|
-
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, claude, code">
|
|
11
|
-
<meta name="robots" content="index, follow">
|
|
12
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html">
|
|
13
|
-
|
|
14
|
-
<!-- Open Graph / Facebook -->
|
|
15
|
-
<meta property="og:type" content="article">
|
|
16
|
-
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html">
|
|
17
|
-
<meta property="og:title" content="Windows Setup Guide for Claude Code & @knowcode...">
|
|
18
|
-
<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...">
|
|
19
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
21
|
-
<meta property="og:locale" content="en_US">
|
|
22
|
-
|
|
23
|
-
<!-- Twitter Card -->
|
|
24
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
25
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
26
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:title" content="Windows Setup Guide for Claude Code & @knowcode...">
|
|
28
|
-
<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...">
|
|
29
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
|
-
|
|
31
|
-
<!-- Custom Meta Tags -->
|
|
32
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
33
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
6
|
+
<meta name="description" content="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Windows Setup Guide for Claude Code & @knowcode/doc-builder - @knowcode/doc-builder</title>
|
|
34
8
|
|
|
35
9
|
<!-- Fonts -->
|
|
36
10
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
37
11
|
|
|
38
12
|
<!-- Icons -->
|
|
39
13
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
40
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
41
14
|
|
|
42
15
|
<!-- Mermaid -->
|
|
43
16
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -45,90 +18,8 @@
|
|
|
45
18
|
<!-- Styles -->
|
|
46
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
47
20
|
|
|
48
|
-
|
|
49
|
-
<!-- Hide content until auth check -->
|
|
50
|
-
<style>
|
|
51
|
-
body {
|
|
52
|
-
visibility: hidden;
|
|
53
|
-
opacity: 0;
|
|
54
|
-
transition: opacity 0.3s ease;
|
|
55
|
-
}
|
|
56
|
-
body.authenticated {
|
|
57
|
-
visibility: visible;
|
|
58
|
-
opacity: 1;
|
|
59
|
-
}
|
|
60
|
-
/* Show login/logout pages immediately */
|
|
61
|
-
body.auth-page {
|
|
62
|
-
visibility: visible;
|
|
63
|
-
opacity: 1;
|
|
64
|
-
}
|
|
65
|
-
/* Style auth button consistently */
|
|
66
|
-
.auth-btn {
|
|
67
|
-
background: none;
|
|
68
|
-
border: none;
|
|
69
|
-
color: var(--text-secondary);
|
|
70
|
-
cursor: pointer;
|
|
71
|
-
padding: 0.5rem;
|
|
72
|
-
border-radius: 0.5rem;
|
|
73
|
-
transition: all 0.2s;
|
|
74
|
-
font-size: 1.1rem;
|
|
75
|
-
}
|
|
76
|
-
.auth-btn:hover {
|
|
77
|
-
background: var(--bg-secondary);
|
|
78
|
-
color: var(--text-primary);
|
|
79
|
-
}
|
|
80
|
-
</style>
|
|
81
|
-
|
|
82
|
-
|
|
83
21
|
<!-- Favicon -->
|
|
84
|
-
<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
|
|
85
|
-
|
|
86
|
-
<script type="application/ld+json">
|
|
87
|
-
{
|
|
88
|
-
"@context": "https://schema.org",
|
|
89
|
-
"@type": "TechArticle",
|
|
90
|
-
"headline": "Windows Setup Guide for Claude Code & @knowcode/doc-builder",
|
|
91
|
-
"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...",
|
|
92
|
-
"author": {
|
|
93
|
-
"@type": "Person",
|
|
94
|
-
"name": "Lindsay Smith"
|
|
95
|
-
},
|
|
96
|
-
"publisher": {
|
|
97
|
-
"@type": "Organization",
|
|
98
|
-
"name": "Knowcode Ltd",
|
|
99
|
-
"url": "https://knowcode.tech"
|
|
100
|
-
},
|
|
101
|
-
"datePublished": "2025-07-26T16:10:10.629Z",
|
|
102
|
-
"dateModified": "2025-07-26T16:10:10.629Z",
|
|
103
|
-
"mainEntityOfPage": {
|
|
104
|
-
"@type": "WebPage",
|
|
105
|
-
"@id": "https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html"
|
|
106
|
-
},
|
|
107
|
-
"breadcrumb": {
|
|
108
|
-
"@type": "BreadcrumbList",
|
|
109
|
-
"itemListElement": [
|
|
110
|
-
{
|
|
111
|
-
"@type": "ListItem",
|
|
112
|
-
"position": 1,
|
|
113
|
-
"name": "@knowcode/doc-builder",
|
|
114
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
115
|
-
},
|
|
116
|
-
{
|
|
117
|
-
"@type": "ListItem",
|
|
118
|
-
"position": 2,
|
|
119
|
-
"name": "Guides",
|
|
120
|
-
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
"@type": "ListItem",
|
|
124
|
-
"position": 3,
|
|
125
|
-
"name": "Windows Setup Guide",
|
|
126
|
-
"item": "https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html"
|
|
127
|
-
}
|
|
128
|
-
]
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
</script>
|
|
22
|
+
<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>">
|
|
132
23
|
</head>
|
|
133
24
|
<body>
|
|
134
25
|
<!-- Header -->
|
|
@@ -138,14 +29,10 @@
|
|
|
138
29
|
|
|
139
30
|
<div class="header-actions">
|
|
140
31
|
<div class="deployment-info">
|
|
141
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
142
33
|
</div>
|
|
143
34
|
|
|
144
35
|
|
|
145
|
-
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
-
</a>
|
|
148
|
-
|
|
149
36
|
|
|
150
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
151
38
|
<i class="fas fa-moon"></i>
|
|
@@ -193,6 +80,7 @@
|
|
|
193
80
|
<div class="nav-content" >
|
|
194
81
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
195
82
|
<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="fas fa-file-alt"></i> Documentation Index</a>
|
|
83
|
+
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
|
|
196
84
|
<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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
197
85
|
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
198
86
|
<div class="nav-section" data-level="1">
|
|
@@ -204,6 +92,7 @@
|
|
|
204
92
|
<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="fas fa-file-alt"></i> Authentication Guide</a>
|
|
205
93
|
<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="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
206
94
|
<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="fas fa-file-alt"></i> Documentation Standards</a>
|
|
95
|
+
<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="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
207
96
|
<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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
208
97
|
<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="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
209
98
|
<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="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
@@ -212,7 +101,7 @@
|
|
|
212
101
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
213
102
|
<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="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
214
103
|
<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="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
215
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
216
105
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
217
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
218
107
|
</a>
|
|
@@ -225,7 +114,7 @@
|
|
|
225
114
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
226
115
|
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
227
116
|
<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="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
228
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
229
118
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
230
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
231
120
|
</a>
|
|
@@ -236,6 +125,12 @@
|
|
|
236
125
|
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
237
126
|
<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="fas fa-file-alt"></i> Launch Announcements</a>
|
|
238
127
|
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
128
|
+
<div class="nav-section" data-level="1">
|
|
129
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
130
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
|
|
131
|
+
</a>
|
|
132
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
133
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
|
|
239
134
|
</nav>
|
|
240
135
|
<div class="resize-handle"></div>
|
|
241
136
|
</aside>
|
|
@@ -249,17 +144,17 @@
|
|
|
249
144
|
<h2>Quick Prerequisites Overview</h2>
|
|
250
145
|
<p><strong>Required Accounts:</strong></p>
|
|
251
146
|
<ul>
|
|
252
|
-
<li
|
|
253
|
-
<li
|
|
254
|
-
<li
|
|
147
|
+
<li>✅ <strong>Claude Pro or Max</strong> subscription ($20-200/month) - <a href="https://claude.ai">claude.ai</a></li>
|
|
148
|
+
<li>✅ <strong>Vercel</strong> account (free Hobby plan) - <a href="https://vercel.com">vercel.com</a></li>
|
|
149
|
+
<li>⭐ <strong>GitHub</strong> account (optional but recommended) - <a href="https://github.com">github.com</a></li>
|
|
255
150
|
</ul>
|
|
256
151
|
<p><strong>Required Software:</strong></p>
|
|
257
152
|
<ul>
|
|
258
|
-
<li
|
|
259
|
-
<li
|
|
260
|
-
<li
|
|
261
|
-
<li
|
|
262
|
-
<li
|
|
153
|
+
<li>✅ Windows 10/11 with Administrator access</li>
|
|
154
|
+
<li>✅ Node.js 14+ and npm - <a href="https://nodejs.org">nodejs.org</a></li>
|
|
155
|
+
<li>✅ Git for Windows - <a href="https://gitforwindows.org">gitforwindows.org</a></li>
|
|
156
|
+
<li>✅ PowerShell 5.1+ (included with Windows)</li>
|
|
157
|
+
<li>⭐ Visual Studio Code (recommended) - <a href="https://code.visualstudio.com">code.visualstudio.com</a></li>
|
|
263
158
|
</ul>
|
|
264
159
|
<h2>Understanding Claude vs Claude Code</h2>
|
|
265
160
|
<h3>What's the Difference?</h3>
|
|
@@ -354,37 +249,37 @@
|
|
|
354
249
|
<td><strong>Windows</strong></td>
|
|
355
250
|
<td>10 or 11</td>
|
|
356
251
|
<td>Operating system</td>
|
|
357
|
-
<td
|
|
252
|
+
<td>✅ Required</td>
|
|
358
253
|
</tr>
|
|
359
254
|
<tr>
|
|
360
255
|
<td><strong>Node.js</strong></td>
|
|
361
256
|
<td>14.0+</td>
|
|
362
257
|
<td>JavaScript runtime</td>
|
|
363
|
-
<td
|
|
258
|
+
<td>✅ Required</td>
|
|
364
259
|
</tr>
|
|
365
260
|
<tr>
|
|
366
261
|
<td><strong>npm</strong></td>
|
|
367
262
|
<td>(included)</td>
|
|
368
263
|
<td>Package manager</td>
|
|
369
|
-
<td
|
|
264
|
+
<td>✅ Required</td>
|
|
370
265
|
</tr>
|
|
371
266
|
<tr>
|
|
372
267
|
<td><strong>Git</strong></td>
|
|
373
268
|
<td>Latest</td>
|
|
374
269
|
<td>Version control</td>
|
|
375
|
-
<td
|
|
270
|
+
<td>✅ Required</td>
|
|
376
271
|
</tr>
|
|
377
272
|
<tr>
|
|
378
273
|
<td><strong>PowerShell</strong></td>
|
|
379
274
|
<td>5.1+</td>
|
|
380
275
|
<td>Command line</td>
|
|
381
|
-
<td
|
|
276
|
+
<td>✅ Required</td>
|
|
382
277
|
</tr>
|
|
383
278
|
<tr>
|
|
384
279
|
<td><strong>VS Code</strong></td>
|
|
385
280
|
<td>Latest</td>
|
|
386
281
|
<td>Code editor</td>
|
|
387
|
-
<td
|
|
282
|
+
<td>⭐ Recommended</td>
|
|
388
283
|
</tr>
|
|
389
284
|
</tbody></table>
|
|
390
285
|
<h3>Administrative Requirements</h3>
|
|
@@ -464,7 +359,7 @@
|
|
|
464
359
|
</li>
|
|
465
360
|
</ul>
|
|
466
361
|
<h2>Step 1: Enable PowerShell Script Execution</h2>
|
|
467
|
-
<p><strong
|
|
362
|
+
<p><strong>⚠️ IMPORTANT</strong>: This must be done FIRST as Administrator</p>
|
|
468
363
|
<h3>Open PowerShell as Administrator</h3>
|
|
469
364
|
<ol>
|
|
470
365
|
<li>Press <code>Windows + X</code></li>
|
|
@@ -486,11 +381,11 @@
|
|
|
486
381
|
<li>Go to <a href="https://nodejs.org/en/download/">Node.js Downloads</a></li>
|
|
487
382
|
<li>Download the <strong>Windows Installer (.msi)</strong> for your system (64-bit recommended)</li>
|
|
488
383
|
<li>Run the installer with these settings:<ul>
|
|
489
|
-
<li
|
|
490
|
-
<li
|
|
491
|
-
<li
|
|
492
|
-
<li
|
|
493
|
-
<li
|
|
384
|
+
<li>✅ Accept the license agreement</li>
|
|
385
|
+
<li>✅ Default installation location</li>
|
|
386
|
+
<li>✅ <strong>IMPORTANT</strong>: Ensure "npm package manager" is checked</li>
|
|
387
|
+
<li>✅ Add to PATH (should be checked by default)</li>
|
|
388
|
+
<li>✅ Automatically install necessary tools (optional but recommended)</li>
|
|
494
389
|
</ul>
|
|
495
390
|
</li>
|
|
496
391
|
</ol>
|
|
@@ -513,11 +408,11 @@ npm -v
|
|
|
513
408
|
<li>Go to <a href="https://gitforwindows.org/">Git for Windows</a></li>
|
|
514
409
|
<li>Download the installer</li>
|
|
515
410
|
<li>Run with these recommended settings:<ul>
|
|
516
|
-
<li
|
|
517
|
-
<li
|
|
518
|
-
<li
|
|
519
|
-
<li
|
|
520
|
-
<li
|
|
411
|
+
<li>✅ Use Visual Studio Code as default editor</li>
|
|
412
|
+
<li>✅ Git from the command line and also from 3rd-party software</li>
|
|
413
|
+
<li>✅ Use bundled OpenSSH</li>
|
|
414
|
+
<li>✅ Checkout Windows-style, commit Unix-style line endings</li>
|
|
415
|
+
<li>✅ Use Windows' default console window</li>
|
|
521
416
|
</ul>
|
|
522
417
|
</li>
|
|
523
418
|
</ol>
|
|
@@ -539,19 +434,19 @@ npm -v
|
|
|
539
434
|
<tbody><tr>
|
|
540
435
|
<td><strong>Free</strong></td>
|
|
541
436
|
<td>$0/month</td>
|
|
542
|
-
<td
|
|
437
|
+
<td>❌ No access</td>
|
|
543
438
|
<td>Basic chat only</td>
|
|
544
439
|
</tr>
|
|
545
440
|
<tr>
|
|
546
441
|
<td><strong>Pro</strong></td>
|
|
547
442
|
<td>$20/month</td>
|
|
548
|
-
<td
|
|
443
|
+
<td>✅ Full access</td>
|
|
549
444
|
<td>Individual developers</td>
|
|
550
445
|
</tr>
|
|
551
446
|
<tr>
|
|
552
447
|
<td><strong>Max</strong></td>
|
|
553
448
|
<td>$200/month</td>
|
|
554
|
-
<td
|
|
449
|
+
<td>✅ Full access</td>
|
|
555
450
|
<td>Power users, higher limits</td>
|
|
556
451
|
</tr>
|
|
557
452
|
</tbody></table>
|
|
@@ -733,10 +628,10 @@ vercel login
|
|
|
733
628
|
</ol>
|
|
734
629
|
<p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
|
|
735
630
|
<ul>
|
|
736
|
-
<li><strong>Lowercase only</strong>: <code>my-docs</code>
|
|
737
|
-
<li><strong>Start with letter</strong>: <code>api-docs</code>
|
|
631
|
+
<li><strong>Lowercase only</strong>: <code>my-docs</code> ✅, <code>My-Docs</code> ❌</li>
|
|
632
|
+
<li><strong>Start with letter</strong>: <code>api-docs</code> ✅, <code>123-docs</code> ❌</li>
|
|
738
633
|
<li><strong>Valid characters</strong>: Letters, numbers, <code>.</code>, <code>_</code>, <code>-</code></li>
|
|
739
|
-
<li><strong>No triple hyphens</strong>: <code>my-cool-docs</code>
|
|
634
|
+
<li><strong>No triple hyphens</strong>: <code>my-cool-docs</code> ✅, <code>my---docs</code> ❌</li>
|
|
740
635
|
</ul>
|
|
741
636
|
<p><strong>Examples of valid names</strong>:</p>
|
|
742
637
|
<ul>
|
|
@@ -823,17 +718,7 @@ npm cache clean --force
|
|
|
823
718
|
</div>
|
|
824
719
|
|
|
825
720
|
<!-- Scripts -->
|
|
826
|
-
<script>
|
|
827
|
-
// Pass configuration to frontend
|
|
828
|
-
window.docBuilderConfig = {
|
|
829
|
-
features: {
|
|
830
|
-
showPdfDownload: true,
|
|
831
|
-
menuDefaultOpen: false
|
|
832
|
-
}
|
|
833
|
-
};
|
|
834
|
-
</script>
|
|
835
721
|
<script src="/js/main.js"></script>
|
|
836
|
-
|
|
837
|
-
<script src="/js/auth.js"></script>
|
|
722
|
+
|
|
838
723
|
</body>
|
|
839
724
|
</html>
|
|
@@ -0,0 +1,189 @@
|
|
|
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="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Image Modal Test - @knowcode/doc-builder</title>
|
|
8
|
+
|
|
9
|
+
<!-- Fonts -->
|
|
10
|
+
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
11
|
+
|
|
12
|
+
<!-- Icons -->
|
|
13
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
14
|
+
|
|
15
|
+
<!-- Mermaid -->
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
17
|
+
|
|
18
|
+
<!-- Styles -->
|
|
19
|
+
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
|
+
|
|
21
|
+
<!-- Favicon -->
|
|
22
|
+
<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>">
|
|
23
|
+
</head>
|
|
24
|
+
<body>
|
|
25
|
+
<!-- Header -->
|
|
26
|
+
<header class="header">
|
|
27
|
+
<div class="header-content">
|
|
28
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
29
|
+
|
|
30
|
+
<div class="header-actions">
|
|
31
|
+
<div class="deployment-info">
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
|
+
<i class="fas fa-moon"></i>
|
|
39
|
+
</button>
|
|
40
|
+
|
|
41
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
42
|
+
<i class="fas fa-bars"></i>
|
|
43
|
+
</button>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
</header>
|
|
47
|
+
|
|
48
|
+
<!-- Preview Banner -->
|
|
49
|
+
<div id="preview-banner" class="preview-banner">
|
|
50
|
+
<div class="banner-content">
|
|
51
|
+
<i class="fas fa-exclamation-triangle banner-icon"></i>
|
|
52
|
+
<span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
|
|
53
|
+
<button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
|
|
54
|
+
<i class="fas fa-times"></i>
|
|
55
|
+
</button>
|
|
56
|
+
</div>
|
|
57
|
+
</div>
|
|
58
|
+
|
|
59
|
+
<!-- Breadcrumbs -->
|
|
60
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
61
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
62
|
+
</nav>
|
|
63
|
+
|
|
64
|
+
<!-- Main Content -->
|
|
65
|
+
<div class="main-wrapper">
|
|
66
|
+
<!-- Sidebar -->
|
|
67
|
+
<aside class="sidebar">
|
|
68
|
+
<div class="sidebar-header">
|
|
69
|
+
<div class="filter-box">
|
|
70
|
+
<input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
|
|
71
|
+
<i class="fas fa-search filter-icon"></i>
|
|
72
|
+
</div>
|
|
73
|
+
</div>
|
|
74
|
+
<nav class="navigation">
|
|
75
|
+
|
|
76
|
+
<div class="nav-section" data-level="0">
|
|
77
|
+
<a class="nav-title expanded" href="/README.html" >
|
|
78
|
+
<i class="fas fa-home"></i> Documentation
|
|
79
|
+
</a>
|
|
80
|
+
<div class="nav-content" >
|
|
81
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
82
|
+
<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="fas fa-file-alt"></i> Documentation Index</a>
|
|
83
|
+
<a href="/image-modal-test.html" class="nav-item active" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
|
|
84
|
+
<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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
85
|
+
<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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
86
|
+
<div class="nav-section" data-level="1">
|
|
87
|
+
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
88
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
89
|
+
</a>
|
|
90
|
+
<div class="nav-content collapsed" id="nav-guides-1">
|
|
91
|
+
<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="fas fa-file-alt"></i> Authentication Default Change</a>
|
|
92
|
+
<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="fas fa-file-alt"></i> Authentication Guide</a>
|
|
93
|
+
<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="fas fa-file-alt"></i> Claude Workflow Guide</a>
|
|
94
|
+
<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="fas fa-file-alt"></i> Documentation Standards</a>
|
|
95
|
+
<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="fas fa-file-alt"></i> Image Modal Guide</a>
|
|
96
|
+
<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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
97
|
+
<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="fas fa-file-alt"></i> Private Directory Authentication</a>
|
|
98
|
+
<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="fas fa-file-alt"></i> Public Site Deployment</a>
|
|
99
|
+
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="fas fa-file-alt"></i> Search Engine Verification Guide</a>
|
|
100
|
+
<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="fas fa-file-alt"></i> Seo Guide</a>
|
|
101
|
+
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
102
|
+
<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="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
103
|
+
<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="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
105
|
+
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
|
+
</a>
|
|
108
|
+
<div class="nav-content collapsed" id="nav-private-1">
|
|
109
|
+
<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="fas fa-file-alt"></i> Cache Control Anti Pattern</a>
|
|
110
|
+
<a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment."><i class="fas fa-file-alt"></i> Next Steps Walkthrough</a>
|
|
111
|
+
<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="fas fa-file-alt"></i> Supabase Auth Implementation Completed</a>
|
|
112
|
+
<a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Supabase Auth Implementation Plan</a>
|
|
113
|
+
<a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Supabase Auth Integration Plan</a>
|
|
114
|
+
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
115
|
+
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="fas fa-file-alt"></i> Test Private Doc</a>
|
|
116
|
+
<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="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
118
|
+
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
|
+
</a>
|
|
121
|
+
<div class="nav-content collapsed" id="nav-private-launch-2">
|
|
122
|
+
<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="fas fa-file-alt"></i> Launch Overview</a>
|
|
123
|
+
<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="fas fa-file-alt"></i> Auth Cleanup Summary</a>
|
|
124
|
+
<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="fas fa-file-alt"></i> Bubble Plugin Specification</a>
|
|
125
|
+
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
126
|
+
<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="fas fa-file-alt"></i> Launch Announcements</a>
|
|
127
|
+
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
128
|
+
<div class="nav-section" data-level="1">
|
|
129
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
130
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
|
|
131
|
+
</a>
|
|
132
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
133
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
|
|
134
|
+
</nav>
|
|
135
|
+
<div class="resize-handle"></div>
|
|
136
|
+
</aside>
|
|
137
|
+
|
|
138
|
+
<!-- Content Area -->
|
|
139
|
+
<main class="content">
|
|
140
|
+
<div class="content-inner">
|
|
141
|
+
<h1>Image Modal Test</h1>
|
|
142
|
+
<p>This document tests the new image modal functionality in doc-builder.</p>
|
|
143
|
+
<h2>Sample Images</h2>
|
|
144
|
+
<p>Here are some test images to demonstrate the modal functionality:</p>
|
|
145
|
+
<h3>Screenshot with Good Alt Text</h3>
|
|
146
|
+
<p><img src="https://via.placeholder.com/800x600/4F46E5/FFFFFF?text=Sample+Screenshot" alt="Doc-builder navigation showing the sidebar with collapsible sections and search functionality"></p>
|
|
147
|
+
<p>This image should open in a modal when clicked, showing the alt text as a caption.</p>
|
|
148
|
+
<h3>Diagram Example</h3>
|
|
149
|
+
<p><img src="https://via.placeholder.com/600x400/10B981/FFFFFF?text=Authentication+Flow" alt="Flow diagram showing the authentication process from login to dashboard access"></p>
|
|
150
|
+
<h3>Image Without Alt Text</h3>
|
|
151
|
+
<p><img src="https://via.placeholder.com/400x300/EF4444/FFFFFF?text=No+Alt+Text" alt=""></p>
|
|
152
|
+
<p>This image has no alt text, so the caption should be hidden in the modal.</p>
|
|
153
|
+
<h3>Multiple Images in a Row</h3>
|
|
154
|
+
<p><img src="https://via.placeholder.com/200x150/F59E0B/FFFFFF?text=Settings" alt="Small thumbnail showing user profile settings"><br><img src="https://via.placeholder.com/200x150/8B5CF6/FFFFFF?text=API+Keys" alt="Configuration panel displaying API key management options"><br><img src="https://via.placeholder.com/200x150/06B6D4/FFFFFF?text=Dashboard" alt="Dashboard overview with analytics charts and metrics"></p>
|
|
155
|
+
<h2>Features to Test</h2>
|
|
156
|
+
<p>When you click on any image above, you should see:</p>
|
|
157
|
+
<ol>
|
|
158
|
+
<li><strong>Modal Opens</strong>: A dark overlay appears with the image centered</li>
|
|
159
|
+
<li><strong>Large View</strong>: The image scales to fit the screen while maintaining aspect ratio</li>
|
|
160
|
+
<li><strong>Close Button</strong>: An "×" button appears in the top-right corner</li>
|
|
161
|
+
<li><strong>Caption Display</strong>: The alt text appears below the image (if present)</li>
|
|
162
|
+
<li><strong>Close Functionality</strong>: <ul>
|
|
163
|
+
<li>Click the × button to close</li>
|
|
164
|
+
<li>Click outside the image to close</li>
|
|
165
|
+
<li>Press Escape key to close</li>
|
|
166
|
+
</ul>
|
|
167
|
+
</li>
|
|
168
|
+
<li><strong>Hover Effects</strong>: Images should have a subtle hover effect before clicking</li>
|
|
169
|
+
<li><strong>Responsive</strong>: Should work well on different screen sizes</li>
|
|
170
|
+
</ol>
|
|
171
|
+
<h2>Expected Behavior</h2>
|
|
172
|
+
<ul>
|
|
173
|
+
<li>Images should be clickable (cursor changes to pointer)</li>
|
|
174
|
+
<li>Smooth transitions and animations</li>
|
|
175
|
+
<li>No page scrolling when modal is open</li>
|
|
176
|
+
<li>Modal should be accessible and keyboard-friendly</li>
|
|
177
|
+
<li>Works in both light and dark themes</li>
|
|
178
|
+
</ul>
|
|
179
|
+
<p>This test demonstrates the image modal system working with various alt text scenarios and image sizes.</p>
|
|
180
|
+
|
|
181
|
+
</div>
|
|
182
|
+
</main>
|
|
183
|
+
</div>
|
|
184
|
+
|
|
185
|
+
<!-- Scripts -->
|
|
186
|
+
<script src="/js/main.js"></script>
|
|
187
|
+
|
|
188
|
+
</body>
|
|
189
|
+
</html>
|