@knowcode/doc-builder 1.9.0 → 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/README.md +2 -0
- package/html/README.html +34 -149
- package/html/css/notion-style.css +13 -394
- package/html/documentation-index.html +17 -127
- package/html/guides/authentication-default-change.html +8 -130
- package/html/guides/authentication-guide.html +20 -141
- package/html/guides/claude-workflow-guide.html +23 -137
- package/html/guides/documentation-standards.html +12 -133
- package/html/guides/image-modal-guide.html +381 -0
- package/html/guides/phosphor-icons-guide.html +28 -150
- package/html/guides/private-directory-authentication.html +8 -130
- package/html/guides/public-site-deployment.html +8 -130
- package/html/guides/search-engine-verification-guide.html +8 -130
- package/html/guides/seo-guide.html +8 -130
- package/html/guides/seo-optimization-guide.html +39 -159
- package/html/guides/troubleshooting-guide.html +20 -141
- package/html/guides/windows-setup-guide.html +39 -161
- package/html/image-modal-test.html +9 -125
- package/html/index.html +34 -149
- package/html/js/auth.js +39 -118
- package/html/js/main.js +25 -259
- package/html/private/cache-control-anti-pattern.html +13 -135
- package/html/private/launch/README.html +16 -144
- package/html/private/launch/auth-cleanup-summary.html +25 -153
- package/html/private/launch/bubble-plugin-specification.html +8 -136
- package/html/private/launch/go-to-market-strategy.html +10 -138
- package/html/private/launch/launch-announcements.html +24 -151
- package/html/private/launch/vercel-deployment-auth-setup.html +10 -138
- package/html/private/next-steps-walkthrough.html +15 -137
- package/html/private/supabase-auth-implementation-completed.html +22 -143
- package/html/private/supabase-auth-implementation-plan.html +15 -136
- package/html/private/supabase-auth-integration-plan.html +22 -142
- package/html/private/supabase-auth-setup-guide.html +17 -139
- package/html/private/test-private-doc.html +8 -130
- package/html/private/user-management-tooling.html +8 -130
- package/html/prompts/markdown-document-standards.html +13 -134
- package/html/vercel-cli-setup-guide.html +12 -128
- package/html/vercel-first-time-setup-guide.html +9 -125
- package/lib/emoji-mapper.js +12 -0
- 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-27T08:30:10.804Z",
|
|
102
|
-
"dateModified": "2025-07-27T08:30:10.804Z",
|
|
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>
|
|
@@ -205,6 +92,7 @@
|
|
|
205
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>
|
|
206
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>
|
|
207
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>
|
|
208
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>
|
|
209
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>
|
|
210
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>
|
|
@@ -213,7 +101,7 @@
|
|
|
213
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>
|
|
214
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>
|
|
215
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>
|
|
216
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
217
105
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
218
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
219
107
|
</a>
|
|
@@ -226,7 +114,7 @@
|
|
|
226
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>
|
|
227
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>
|
|
228
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>
|
|
229
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
230
118
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
231
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
232
120
|
</a>
|
|
@@ -256,17 +144,17 @@
|
|
|
256
144
|
<h2>Quick Prerequisites Overview</h2>
|
|
257
145
|
<p><strong>Required Accounts:</strong></p>
|
|
258
146
|
<ul>
|
|
259
|
-
<li
|
|
260
|
-
<li
|
|
261
|
-
<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>
|
|
262
150
|
</ul>
|
|
263
151
|
<p><strong>Required Software:</strong></p>
|
|
264
152
|
<ul>
|
|
265
|
-
<li
|
|
266
|
-
<li
|
|
267
|
-
<li
|
|
268
|
-
<li
|
|
269
|
-
<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>
|
|
270
158
|
</ul>
|
|
271
159
|
<h2>Understanding Claude vs Claude Code</h2>
|
|
272
160
|
<h3>What's the Difference?</h3>
|
|
@@ -361,37 +249,37 @@
|
|
|
361
249
|
<td><strong>Windows</strong></td>
|
|
362
250
|
<td>10 or 11</td>
|
|
363
251
|
<td>Operating system</td>
|
|
364
|
-
<td
|
|
252
|
+
<td>✅ Required</td>
|
|
365
253
|
</tr>
|
|
366
254
|
<tr>
|
|
367
255
|
<td><strong>Node.js</strong></td>
|
|
368
256
|
<td>14.0+</td>
|
|
369
257
|
<td>JavaScript runtime</td>
|
|
370
|
-
<td
|
|
258
|
+
<td>✅ Required</td>
|
|
371
259
|
</tr>
|
|
372
260
|
<tr>
|
|
373
261
|
<td><strong>npm</strong></td>
|
|
374
262
|
<td>(included)</td>
|
|
375
263
|
<td>Package manager</td>
|
|
376
|
-
<td
|
|
264
|
+
<td>✅ Required</td>
|
|
377
265
|
</tr>
|
|
378
266
|
<tr>
|
|
379
267
|
<td><strong>Git</strong></td>
|
|
380
268
|
<td>Latest</td>
|
|
381
269
|
<td>Version control</td>
|
|
382
|
-
<td
|
|
270
|
+
<td>✅ Required</td>
|
|
383
271
|
</tr>
|
|
384
272
|
<tr>
|
|
385
273
|
<td><strong>PowerShell</strong></td>
|
|
386
274
|
<td>5.1+</td>
|
|
387
275
|
<td>Command line</td>
|
|
388
|
-
<td
|
|
276
|
+
<td>✅ Required</td>
|
|
389
277
|
</tr>
|
|
390
278
|
<tr>
|
|
391
279
|
<td><strong>VS Code</strong></td>
|
|
392
280
|
<td>Latest</td>
|
|
393
281
|
<td>Code editor</td>
|
|
394
|
-
<td
|
|
282
|
+
<td>⭐ Recommended</td>
|
|
395
283
|
</tr>
|
|
396
284
|
</tbody></table>
|
|
397
285
|
<h3>Administrative Requirements</h3>
|
|
@@ -471,7 +359,7 @@
|
|
|
471
359
|
</li>
|
|
472
360
|
</ul>
|
|
473
361
|
<h2>Step 1: Enable PowerShell Script Execution</h2>
|
|
474
|
-
<p><strong
|
|
362
|
+
<p><strong>⚠️ IMPORTANT</strong>: This must be done FIRST as Administrator</p>
|
|
475
363
|
<h3>Open PowerShell as Administrator</h3>
|
|
476
364
|
<ol>
|
|
477
365
|
<li>Press <code>Windows + X</code></li>
|
|
@@ -493,11 +381,11 @@
|
|
|
493
381
|
<li>Go to <a href="https://nodejs.org/en/download/">Node.js Downloads</a></li>
|
|
494
382
|
<li>Download the <strong>Windows Installer (.msi)</strong> for your system (64-bit recommended)</li>
|
|
495
383
|
<li>Run the installer with these settings:<ul>
|
|
496
|
-
<li
|
|
497
|
-
<li
|
|
498
|
-
<li
|
|
499
|
-
<li
|
|
500
|
-
<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>
|
|
501
389
|
</ul>
|
|
502
390
|
</li>
|
|
503
391
|
</ol>
|
|
@@ -520,11 +408,11 @@ npm -v
|
|
|
520
408
|
<li>Go to <a href="https://gitforwindows.org/">Git for Windows</a></li>
|
|
521
409
|
<li>Download the installer</li>
|
|
522
410
|
<li>Run with these recommended settings:<ul>
|
|
523
|
-
<li
|
|
524
|
-
<li
|
|
525
|
-
<li
|
|
526
|
-
<li
|
|
527
|
-
<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>
|
|
528
416
|
</ul>
|
|
529
417
|
</li>
|
|
530
418
|
</ol>
|
|
@@ -546,19 +434,19 @@ npm -v
|
|
|
546
434
|
<tbody><tr>
|
|
547
435
|
<td><strong>Free</strong></td>
|
|
548
436
|
<td>$0/month</td>
|
|
549
|
-
<td
|
|
437
|
+
<td>❌ No access</td>
|
|
550
438
|
<td>Basic chat only</td>
|
|
551
439
|
</tr>
|
|
552
440
|
<tr>
|
|
553
441
|
<td><strong>Pro</strong></td>
|
|
554
442
|
<td>$20/month</td>
|
|
555
|
-
<td
|
|
443
|
+
<td>✅ Full access</td>
|
|
556
444
|
<td>Individual developers</td>
|
|
557
445
|
</tr>
|
|
558
446
|
<tr>
|
|
559
447
|
<td><strong>Max</strong></td>
|
|
560
448
|
<td>$200/month</td>
|
|
561
|
-
<td
|
|
449
|
+
<td>✅ Full access</td>
|
|
562
450
|
<td>Power users, higher limits</td>
|
|
563
451
|
</tr>
|
|
564
452
|
</tbody></table>
|
|
@@ -740,10 +628,10 @@ vercel login
|
|
|
740
628
|
</ol>
|
|
741
629
|
<p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
|
|
742
630
|
<ul>
|
|
743
|
-
<li><strong>Lowercase only</strong>: <code>my-docs</code>
|
|
744
|
-
<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>
|
|
745
633
|
<li><strong>Valid characters</strong>: Letters, numbers, <code>.</code>, <code>_</code>, <code>-</code></li>
|
|
746
|
-
<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>
|
|
747
635
|
</ul>
|
|
748
636
|
<p><strong>Examples of valid names</strong>:</p>
|
|
749
637
|
<ul>
|
|
@@ -830,17 +718,7 @@ npm cache clean --force
|
|
|
830
718
|
</div>
|
|
831
719
|
|
|
832
720
|
<!-- Scripts -->
|
|
833
|
-
<script>
|
|
834
|
-
// Pass configuration to frontend
|
|
835
|
-
window.docBuilderConfig = {
|
|
836
|
-
features: {
|
|
837
|
-
showPdfDownload: true,
|
|
838
|
-
menuDefaultOpen: false
|
|
839
|
-
}
|
|
840
|
-
};
|
|
841
|
-
</script>
|
|
842
721
|
<script src="/js/main.js"></script>
|
|
843
|
-
|
|
844
|
-
<script src="/js/auth.js"></script>
|
|
722
|
+
|
|
845
723
|
</body>
|
|
846
724
|
</html>
|
|
@@ -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>Image Modal Test
|
|
8
|
-
|
|
9
|
-
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, image, modal">
|
|
11
|
-
<meta name="robots" content="index, follow">
|
|
12
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/image-modal-test.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/image-modal-test.html">
|
|
17
|
-
<meta property="og:title" content="Image Modal Test | @knowcode/doc-builder">
|
|
18
|
-
<meta property="og:description" content="This document tests the new image modal functionality in doc-builder.">
|
|
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="Image Modal Test | @knowcode/doc-builder">
|
|
28
|
-
<meta name="twitter:description" content="This document tests the new image modal functionality in doc-builder.">
|
|
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>Image Modal Test - @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,84 +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": "Image Modal Test",
|
|
91
|
-
"description": "This document tests the new image modal functionality in doc-builder.",
|
|
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-27T08:30:10.805Z",
|
|
102
|
-
"dateModified": "2025-07-27T08:30:10.805Z",
|
|
103
|
-
"mainEntityOfPage": {
|
|
104
|
-
"@type": "WebPage",
|
|
105
|
-
"@id": "https://doc-builder-delta.vercel.app/image-modal-test.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": "Image Modal Test",
|
|
120
|
-
"item": "https://doc-builder-delta.vercel.app/image-modal-test.html"
|
|
121
|
-
}
|
|
122
|
-
]
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
</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>">
|
|
126
23
|
</head>
|
|
127
24
|
<body>
|
|
128
25
|
<!-- Header -->
|
|
@@ -132,14 +29,10 @@
|
|
|
132
29
|
|
|
133
30
|
<div class="header-actions">
|
|
134
31
|
<div class="deployment-info">
|
|
135
|
-
<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>
|
|
136
33
|
</div>
|
|
137
34
|
|
|
138
35
|
|
|
139
|
-
<a href="../login.html" class="auth-btn" title="Login/Logout">
|
|
140
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
141
|
-
</a>
|
|
142
|
-
|
|
143
36
|
|
|
144
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
145
38
|
<i class="fas fa-moon"></i>
|
|
@@ -181,7 +74,7 @@
|
|
|
181
74
|
<nav class="navigation">
|
|
182
75
|
|
|
183
76
|
<div class="nav-section" data-level="0">
|
|
184
|
-
<a class="nav-title" href="/README.html" >
|
|
77
|
+
<a class="nav-title expanded" href="/README.html" >
|
|
185
78
|
<i class="fas fa-home"></i> Documentation
|
|
186
79
|
</a>
|
|
187
80
|
<div class="nav-content" >
|
|
@@ -199,6 +92,7 @@
|
|
|
199
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>
|
|
200
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>
|
|
201
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>
|
|
202
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>
|
|
203
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>
|
|
204
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>
|
|
@@ -207,7 +101,7 @@
|
|
|
207
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>
|
|
208
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>
|
|
209
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>
|
|
210
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
211
105
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
212
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
213
107
|
</a>
|
|
@@ -220,7 +114,7 @@
|
|
|
220
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>
|
|
221
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>
|
|
222
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>
|
|
223
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
224
118
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
225
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
226
120
|
</a>
|
|
@@ -289,17 +183,7 @@
|
|
|
289
183
|
</div>
|
|
290
184
|
|
|
291
185
|
<!-- Scripts -->
|
|
292
|
-
<script>
|
|
293
|
-
// Pass configuration to frontend
|
|
294
|
-
window.docBuilderConfig = {
|
|
295
|
-
features: {
|
|
296
|
-
showPdfDownload: true,
|
|
297
|
-
menuDefaultOpen: false
|
|
298
|
-
}
|
|
299
|
-
};
|
|
300
|
-
</script>
|
|
301
186
|
<script src="/js/main.js"></script>
|
|
302
|
-
|
|
303
|
-
<script src="/js/auth.js"></script>
|
|
187
|
+
|
|
304
188
|
</body>
|
|
305
189
|
</html>
|