@knowcode/doc-builder 1.9.1 → 1.9.3
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/CHANGELOG.md +29 -0
- package/CLAUDE.md +35 -0
- package/README.md +1 -0
- package/assets/css/notion-style.css +2 -2
- package/html/README.html +151 -33
- package/html/auth.js +4 -3
- package/html/css/notion-style.css +394 -13
- package/html/documentation-index.html +134 -10
- package/html/guides/authentication-default-change.html +132 -7
- package/html/guides/authentication-guide.html +143 -19
- package/html/guides/claude-workflow-guide.html +139 -22
- package/html/guides/documentation-standards.html +135 -11
- package/html/guides/html-embedding-guide.html +451 -0
- package/html/guides/image-modal-guide.html +134 -10
- package/html/guides/phosphor-icons-guide.html +152 -27
- package/html/guides/private-directory-authentication-troubleshooting.html +545 -0
- package/html/guides/private-directory-authentication.html +132 -7
- package/html/guides/public-site-deployment.html +132 -7
- package/html/guides/search-engine-verification-guide.html +132 -7
- package/html/guides/seo-guide.html +132 -7
- package/html/guides/seo-optimization-guide.html +161 -38
- package/html/guides/troubleshooting-guide.html +143 -19
- package/html/guides/windows-setup-guide.html +163 -38
- package/html/image-modal-test.html +127 -8
- package/html/index.html +151 -33
- package/html/js/auth.js +119 -39
- package/html/js/main.js +259 -25
- package/html/private/cache-control-anti-pattern.html +137 -12
- package/html/private/launch/README.html +146 -15
- package/html/private/launch/auth-cleanup-summary.html +155 -24
- package/html/private/launch/bubble-plugin-specification.html +138 -7
- package/html/private/launch/go-to-market-strategy.html +140 -9
- package/html/private/launch/launch-announcements.html +154 -24
- package/html/private/launch/vercel-deployment-auth-setup.html +140 -9
- package/html/private/next-steps-walkthrough.html +139 -14
- package/html/private/supabase-auth-implementation-completed.html +145 -21
- package/html/private/supabase-auth-implementation-plan.html +138 -14
- package/html/private/supabase-auth-integration-plan.html +144 -21
- package/html/private/supabase-auth-setup-guide.html +141 -16
- package/html/private/test-private-doc.html +132 -7
- package/html/private/user-management-tooling.html +132 -7
- package/html/prompts/markdown-document-standards.html +136 -12
- package/html/sitemap.xml +70 -46
- package/html/vercel-cli-setup-guide.html +130 -11
- package/html/vercel-first-time-setup-guide.html +127 -8
- package/lib/config.js +2 -0
- package/lib/emoji-mapper.js +2 -0
- package/lib/supabase-auth.js +4 -3
- package/package.json +1 -1
|
@@ -3,14 +3,41 @@
|
|
|
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>Troubleshooting Guide for @knowcode/doc-builder
|
|
6
|
+
<meta name="description" content="This guide helps you resolve common issues when using @knowcode/doc-builder. Most problems have simple solutions, and this guide covers the most frequent ones.">
|
|
7
|
+
<title>Troubleshooting Guide for @knowcode/doc-builder</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, issues, check">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/troubleshooting-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/troubleshooting-guide.html">
|
|
17
|
+
<meta property="og:title" content="Troubleshooting Guide for @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="This guide helps you resolve common issues when using @knowcode/doc-builder. Most problems have simple solutions, and this guide covers the most frequent ones.">
|
|
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="Troubleshooting Guide for @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="This guide helps you resolve common issues when using @knowcode/doc-builder. Most problems have simple solutions, and this guide covers the most frequent ones.">
|
|
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">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<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
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<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">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
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
|
+
|
|
21
83
|
<!-- 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
|
|
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>✨</text></svg>">
|
|
85
|
+
|
|
86
|
+
<script type="application/ld+json">
|
|
87
|
+
{
|
|
88
|
+
"@context": "https://schema.org",
|
|
89
|
+
"@type": "TechArticle",
|
|
90
|
+
"headline": "Troubleshooting Guide for @knowcode/doc-builder",
|
|
91
|
+
"description": "This guide helps you resolve common issues when using @knowcode/doc-builder. Most problems have simple solutions, and this guide covers the most frequent ones.",
|
|
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-28T16:34:27.949Z",
|
|
102
|
+
"dateModified": "2025-07-28T16:34:27.949Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-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": "Troubleshooting Guide",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
|
|
127
|
+
}
|
|
128
|
+
]
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
</script>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.3">Last updated: Jul 28, 2025, 04:34 PM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,16 +205,18 @@
|
|
|
92
205
|
<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
206
|
<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
207
|
<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>
|
|
208
|
+
<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="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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
210
|
<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
211
|
<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>
|
|
212
|
+
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="fas fa-file-alt"></i> Private Directory Authentication Troubleshooting</a>
|
|
98
213
|
<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
214
|
<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
215
|
<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
216
|
<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
217
|
<a href="/guides/troubleshooting-guide.html" class="nav-item active" 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
218
|
<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">
|
|
219
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
220
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
221
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
222
|
</a>
|
|
@@ -114,7 +229,7 @@
|
|
|
114
229
|
<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
230
|
<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
231
|
<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">
|
|
232
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
233
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
234
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
235
|
</a>
|
|
@@ -146,10 +261,10 @@
|
|
|
146
261
|
<p>The most common issue users face is npx caching an older version of doc-builder.</p>
|
|
147
262
|
<p><strong>Symptoms:</strong></p>
|
|
148
263
|
<ul>
|
|
149
|
-
<li
|
|
150
|
-
<li
|
|
151
|
-
<li
|
|
152
|
-
<li
|
|
264
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
|
|
265
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> New features aren't available despite updating</li>
|
|
266
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Bug fixes don't appear to be working</li>
|
|
267
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> Version shown doesn't match npm registry</li>
|
|
153
268
|
</ul>
|
|
154
269
|
<p><strong>Example:</strong></p>
|
|
155
270
|
<pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
|
|
@@ -171,7 +286,6 @@ npx @knowcode/doc-builder@1.4.22
|
|
|
171
286
|
</code></pre>
|
|
172
287
|
<h3>Why This Happens</h3>
|
|
173
288
|
<div class="mermaid-wrapper">
|
|
174
|
-
<div class="mermaid-title">Diagram</div>
|
|
175
289
|
<div class="mermaid">graph TD
|
|
176
290
|
A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
|
|
177
291
|
B -->|Yes| C[Use cached version]
|
|
@@ -213,10 +327,10 @@ npx doc-builder deploy # Uses local version
|
|
|
213
327
|
</li>
|
|
214
328
|
<li><p><strong>Ensure correct file extensions:</strong></p>
|
|
215
329
|
<ul>
|
|
216
|
-
<li
|
|
217
|
-
<li
|
|
218
|
-
<li
|
|
219
|
-
<li
|
|
330
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
|
|
331
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
|
|
332
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
|
|
333
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
|
|
220
334
|
</ul>
|
|
221
335
|
</li>
|
|
222
336
|
<li><p><strong>Use custom input directory:</strong></p>
|
|
@@ -296,9 +410,9 @@ npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
|
|
|
296
410
|
<ol>
|
|
297
411
|
<li><p><strong>Check file name:</strong></p>
|
|
298
412
|
<ul>
|
|
299
|
-
<li
|
|
300
|
-
<li
|
|
301
|
-
<li
|
|
413
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
|
|
414
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
|
|
415
|
+
<li><i class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
|
|
302
416
|
</ul>
|
|
303
417
|
</li>
|
|
304
418
|
<li><p><strong>Verify export format:</strong></p>
|
|
@@ -493,7 +607,17 @@ npm --version
|
|
|
493
607
|
</div>
|
|
494
608
|
|
|
495
609
|
<!-- Scripts -->
|
|
610
|
+
<script>
|
|
611
|
+
// Pass configuration to frontend
|
|
612
|
+
window.docBuilderConfig = {
|
|
613
|
+
features: {
|
|
614
|
+
showPdfDownload: true,
|
|
615
|
+
menuDefaultOpen: false
|
|
616
|
+
}
|
|
617
|
+
};
|
|
618
|
+
</script>
|
|
496
619
|
<script src="/js/main.js"></script>
|
|
497
|
-
|
|
620
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
621
|
+
<script src="/js/auth.js"></script>
|
|
498
622
|
</body>
|
|
499
623
|
</html>
|
|
@@ -3,14 +3,41 @@
|
|
|
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 & @knowcode
|
|
6
|
+
<meta name="description" content="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel. Based on real...">
|
|
7
|
+
<title>Windows Setup Guide for Claude Code & @knowcode...</title>
|
|
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">
|
|
8
34
|
|
|
9
35
|
<!-- Fonts -->
|
|
10
36
|
<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
37
|
|
|
12
38
|
<!-- Icons -->
|
|
13
39
|
<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">
|
|
14
41
|
|
|
15
42
|
<!-- Mermaid -->
|
|
16
43
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -18,8 +45,90 @@
|
|
|
18
45
|
<!-- Styles -->
|
|
19
46
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
20
47
|
|
|
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
|
+
|
|
21
83
|
<!-- 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
|
|
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>✨</text></svg>">
|
|
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-28T16:34:27.953Z",
|
|
102
|
+
"dateModified": "2025-07-28T16:34:27.953Z",
|
|
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>
|
|
23
132
|
</head>
|
|
24
133
|
<body>
|
|
25
134
|
<!-- Header -->
|
|
@@ -29,10 +138,14 @@
|
|
|
29
138
|
|
|
30
139
|
<div class="header-actions">
|
|
31
140
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
141
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.3">Last updated: Jul 28, 2025, 04:34 PM UTC</span>
|
|
33
142
|
</div>
|
|
34
143
|
|
|
35
144
|
|
|
145
|
+
<a href="../../login.html" class="auth-btn" title="Login/Logout">
|
|
146
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
147
|
+
</a>
|
|
148
|
+
|
|
36
149
|
|
|
37
150
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
151
|
<i class="fas fa-moon"></i>
|
|
@@ -92,16 +205,18 @@
|
|
|
92
205
|
<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
206
|
<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
207
|
<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>
|
|
208
|
+
<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="fas fa-file-alt"></i> Html Embedding Guide</a>
|
|
95
209
|
<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
210
|
<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
211
|
<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>
|
|
212
|
+
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="fas fa-file-alt"></i> Private Directory Authentication Troubleshooting</a>
|
|
98
213
|
<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
214
|
<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
215
|
<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
216
|
<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
217
|
<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
218
|
<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>
|
|
104
|
-
<div class="nav-section" data-level="1">
|
|
219
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
220
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
221
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
222
|
</a>
|
|
@@ -114,7 +229,7 @@
|
|
|
114
229
|
<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
230
|
<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
231
|
<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">
|
|
232
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
233
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
234
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
235
|
</a>
|
|
@@ -144,17 +259,17 @@
|
|
|
144
259
|
<h2>Quick Prerequisites Overview</h2>
|
|
145
260
|
<p><strong>Required Accounts:</strong></p>
|
|
146
261
|
<ul>
|
|
147
|
-
<li
|
|
148
|
-
<li
|
|
149
|
-
<li
|
|
262
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Claude Pro or Max</strong> subscription ($20-200/month) - <a href="https://claude.ai">claude.ai</a></li>
|
|
263
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Vercel</strong> account (free Hobby plan) - <a href="https://vercel.com">vercel.com</a></li>
|
|
264
|
+
<li><i class="ph ph-star" aria-label="star"></i> <strong>GitHub</strong> account (optional but recommended) - <a href="https://github.com">github.com</a></li>
|
|
150
265
|
</ul>
|
|
151
266
|
<p><strong>Required Software:</strong></p>
|
|
152
267
|
<ul>
|
|
153
|
-
<li
|
|
154
|
-
<li
|
|
155
|
-
<li
|
|
156
|
-
<li
|
|
157
|
-
<li
|
|
268
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Windows 10/11 with Administrator access</li>
|
|
269
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Node.js 14+ and npm - <a href="https://nodejs.org">nodejs.org</a></li>
|
|
270
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Git for Windows - <a href="https://gitforwindows.org">gitforwindows.org</a></li>
|
|
271
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> PowerShell 5.1+ (included with Windows)</li>
|
|
272
|
+
<li><i class="ph ph-star" aria-label="star"></i> Visual Studio Code (recommended) - <a href="https://code.visualstudio.com">code.visualstudio.com</a></li>
|
|
158
273
|
</ul>
|
|
159
274
|
<h2>Understanding Claude vs Claude Code</h2>
|
|
160
275
|
<h3>What's the Difference?</h3>
|
|
@@ -249,37 +364,37 @@
|
|
|
249
364
|
<td><strong>Windows</strong></td>
|
|
250
365
|
<td>10 or 11</td>
|
|
251
366
|
<td>Operating system</td>
|
|
252
|
-
<td
|
|
367
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
|
|
253
368
|
</tr>
|
|
254
369
|
<tr>
|
|
255
370
|
<td><strong>Node.js</strong></td>
|
|
256
371
|
<td>14.0+</td>
|
|
257
372
|
<td>JavaScript runtime</td>
|
|
258
|
-
<td
|
|
373
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
|
|
259
374
|
</tr>
|
|
260
375
|
<tr>
|
|
261
376
|
<td><strong>npm</strong></td>
|
|
262
377
|
<td>(included)</td>
|
|
263
378
|
<td>Package manager</td>
|
|
264
|
-
<td
|
|
379
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
|
|
265
380
|
</tr>
|
|
266
381
|
<tr>
|
|
267
382
|
<td><strong>Git</strong></td>
|
|
268
383
|
<td>Latest</td>
|
|
269
384
|
<td>Version control</td>
|
|
270
|
-
<td
|
|
385
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
|
|
271
386
|
</tr>
|
|
272
387
|
<tr>
|
|
273
388
|
<td><strong>PowerShell</strong></td>
|
|
274
389
|
<td>5.1+</td>
|
|
275
390
|
<td>Command line</td>
|
|
276
|
-
<td
|
|
391
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
|
|
277
392
|
</tr>
|
|
278
393
|
<tr>
|
|
279
394
|
<td><strong>VS Code</strong></td>
|
|
280
395
|
<td>Latest</td>
|
|
281
396
|
<td>Code editor</td>
|
|
282
|
-
<td
|
|
397
|
+
<td><i class="ph ph-star" aria-label="star"></i> Recommended</td>
|
|
283
398
|
</tr>
|
|
284
399
|
</tbody></table>
|
|
285
400
|
<h3>Administrative Requirements</h3>
|
|
@@ -359,7 +474,7 @@
|
|
|
359
474
|
</li>
|
|
360
475
|
</ul>
|
|
361
476
|
<h2>Step 1: Enable PowerShell Script Execution</h2>
|
|
362
|
-
<p><strong
|
|
477
|
+
<p><strong><i class="ph ph-warning-circle" aria-label="warning"></i> IMPORTANT</strong>: This must be done FIRST as Administrator</p>
|
|
363
478
|
<h3>Open PowerShell as Administrator</h3>
|
|
364
479
|
<ol>
|
|
365
480
|
<li>Press <code>Windows + X</code></li>
|
|
@@ -381,11 +496,11 @@
|
|
|
381
496
|
<li>Go to <a href="https://nodejs.org/en/download/">Node.js Downloads</a></li>
|
|
382
497
|
<li>Download the <strong>Windows Installer (.msi)</strong> for your system (64-bit recommended)</li>
|
|
383
498
|
<li>Run the installer with these settings:<ul>
|
|
384
|
-
<li
|
|
385
|
-
<li
|
|
386
|
-
<li
|
|
387
|
-
<li
|
|
388
|
-
<li
|
|
499
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Accept the license agreement</li>
|
|
500
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Default installation location</li>
|
|
501
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>IMPORTANT</strong>: Ensure "npm package manager" is checked</li>
|
|
502
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Add to PATH (should be checked by default)</li>
|
|
503
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Automatically install necessary tools (optional but recommended)</li>
|
|
389
504
|
</ul>
|
|
390
505
|
</li>
|
|
391
506
|
</ol>
|
|
@@ -408,11 +523,11 @@ npm -v
|
|
|
408
523
|
<li>Go to <a href="https://gitforwindows.org/">Git for Windows</a></li>
|
|
409
524
|
<li>Download the installer</li>
|
|
410
525
|
<li>Run with these recommended settings:<ul>
|
|
411
|
-
<li
|
|
412
|
-
<li
|
|
413
|
-
<li
|
|
414
|
-
<li
|
|
415
|
-
<li
|
|
526
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Use Visual Studio Code as default editor</li>
|
|
527
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Git from the command line and also from 3rd-party software</li>
|
|
528
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Use bundled OpenSSH</li>
|
|
529
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Checkout Windows-style, commit Unix-style line endings</li>
|
|
530
|
+
<li><i class="ph ph-check-circle" aria-label="checked"></i> Use Windows' default console window</li>
|
|
416
531
|
</ul>
|
|
417
532
|
</li>
|
|
418
533
|
</ol>
|
|
@@ -434,19 +549,19 @@ npm -v
|
|
|
434
549
|
<tbody><tr>
|
|
435
550
|
<td><strong>Free</strong></td>
|
|
436
551
|
<td>$0/month</td>
|
|
437
|
-
<td
|
|
552
|
+
<td><i class="ph ph-x-circle" aria-label="error"></i> No access</td>
|
|
438
553
|
<td>Basic chat only</td>
|
|
439
554
|
</tr>
|
|
440
555
|
<tr>
|
|
441
556
|
<td><strong>Pro</strong></td>
|
|
442
557
|
<td>$20/month</td>
|
|
443
|
-
<td
|
|
558
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
|
|
444
559
|
<td>Individual developers</td>
|
|
445
560
|
</tr>
|
|
446
561
|
<tr>
|
|
447
562
|
<td><strong>Max</strong></td>
|
|
448
563
|
<td>$200/month</td>
|
|
449
|
-
<td
|
|
564
|
+
<td><i class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
|
|
450
565
|
<td>Power users, higher limits</td>
|
|
451
566
|
</tr>
|
|
452
567
|
</tbody></table>
|
|
@@ -628,10 +743,10 @@ vercel login
|
|
|
628
743
|
</ol>
|
|
629
744
|
<p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
|
|
630
745
|
<ul>
|
|
631
|
-
<li><strong>Lowercase only</strong>: <code>my-docs</code>
|
|
632
|
-
<li><strong>Start with letter</strong>: <code>api-docs</code>
|
|
746
|
+
<li><strong>Lowercase only</strong>: <code>my-docs</code> <i class="ph ph-check-circle" aria-label="checked"></i>, <code>My-Docs</code> <i class="ph ph-x-circle" aria-label="error"></i></li>
|
|
747
|
+
<li><strong>Start with letter</strong>: <code>api-docs</code> <i class="ph ph-check-circle" aria-label="checked"></i>, <code>123-docs</code> <i class="ph ph-x-circle" aria-label="error"></i></li>
|
|
633
748
|
<li><strong>Valid characters</strong>: Letters, numbers, <code>.</code>, <code>_</code>, <code>-</code></li>
|
|
634
|
-
<li><strong>No triple hyphens</strong>: <code>my-cool-docs</code>
|
|
749
|
+
<li><strong>No triple hyphens</strong>: <code>my-cool-docs</code> <i class="ph ph-check-circle" aria-label="checked"></i>, <code>my---docs</code> <i class="ph ph-x-circle" aria-label="error"></i></li>
|
|
635
750
|
</ul>
|
|
636
751
|
<p><strong>Examples of valid names</strong>:</p>
|
|
637
752
|
<ul>
|
|
@@ -718,7 +833,17 @@ npm cache clean --force
|
|
|
718
833
|
</div>
|
|
719
834
|
|
|
720
835
|
<!-- Scripts -->
|
|
836
|
+
<script>
|
|
837
|
+
// Pass configuration to frontend
|
|
838
|
+
window.docBuilderConfig = {
|
|
839
|
+
features: {
|
|
840
|
+
showPdfDownload: true,
|
|
841
|
+
menuDefaultOpen: false
|
|
842
|
+
}
|
|
843
|
+
};
|
|
844
|
+
</script>
|
|
721
845
|
<script src="/js/main.js"></script>
|
|
722
|
-
|
|
846
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
847
|
+
<script src="/js/auth.js"></script>
|
|
723
848
|
</body>
|
|
724
849
|
</html>
|