@knowcode/doc-builder 1.9.1 → 1.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/README.md +1 -0
  3. package/html/README.html +150 -33
  4. package/html/css/notion-style.css +394 -13
  5. package/html/documentation-index.html +128 -10
  6. package/html/guides/authentication-default-change.html +131 -7
  7. package/html/guides/authentication-guide.html +142 -19
  8. package/html/guides/claude-workflow-guide.html +138 -22
  9. package/html/guides/documentation-standards.html +134 -11
  10. package/html/guides/html-embedding-guide.html +450 -0
  11. package/html/guides/image-modal-guide.html +133 -10
  12. package/html/guides/phosphor-icons-guide.html +151 -27
  13. package/html/guides/private-directory-authentication.html +131 -7
  14. package/html/guides/public-site-deployment.html +131 -7
  15. package/html/guides/search-engine-verification-guide.html +131 -7
  16. package/html/guides/seo-guide.html +131 -7
  17. package/html/guides/seo-optimization-guide.html +160 -38
  18. package/html/guides/troubleshooting-guide.html +142 -19
  19. package/html/guides/windows-setup-guide.html +162 -38
  20. package/html/image-modal-test.html +126 -8
  21. package/html/index.html +150 -33
  22. package/html/js/auth.js +118 -39
  23. package/html/js/main.js +259 -25
  24. package/html/private/cache-control-anti-pattern.html +136 -12
  25. package/html/private/launch/README.html +145 -15
  26. package/html/private/launch/auth-cleanup-summary.html +154 -24
  27. package/html/private/launch/bubble-plugin-specification.html +137 -7
  28. package/html/private/launch/go-to-market-strategy.html +139 -9
  29. package/html/private/launch/launch-announcements.html +153 -24
  30. package/html/private/launch/vercel-deployment-auth-setup.html +139 -9
  31. package/html/private/next-steps-walkthrough.html +138 -14
  32. package/html/private/supabase-auth-implementation-completed.html +144 -21
  33. package/html/private/supabase-auth-implementation-plan.html +137 -14
  34. package/html/private/supabase-auth-integration-plan.html +143 -21
  35. package/html/private/supabase-auth-setup-guide.html +140 -16
  36. package/html/private/test-private-doc.html +131 -7
  37. package/html/private/user-management-tooling.html +131 -7
  38. package/html/prompts/markdown-document-standards.html +135 -12
  39. package/html/sitemap.xml +58 -46
  40. package/html/vercel-cli-setup-guide.html +129 -11
  41. package/html/vercel-first-time-setup-guide.html +126 -8
  42. package/lib/config.js +2 -0
  43. package/package.json +1 -1
package/html/guides/troubleshooting-guide.html CHANGED
@@ -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="Beautiful documentation with the least effort possible">
7
- <title>Troubleshooting Guide for @knowcode/doc-builder - @knowcode/doc-builder</title>
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>📚</text></svg>">
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-28T10:31:53.222Z",
102
+ "dateModified": "2025-07-28T10:31:53.222Z",
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.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
141
+ <span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM 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,6 +205,7 @@
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>
@@ -101,7 +215,7 @@
101
215
  <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
216
  <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
217
  <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">
218
+ <div class="nav-section private-nav" data-level="1">
105
219
  <a class="nav-title collapsible" href="#" data-target="nav-private-1" >
106
220
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
107
221
  </a>
@@ -114,7 +228,7 @@
114
228
  <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
229
  <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
230
  <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">
231
+ <div class="nav-section private-nav" data-level="2">
118
232
  <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
119
233
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
120
234
  </a>
@@ -146,10 +260,10 @@
146
260
  <p>The most common issue users face is npx caching an older version of doc-builder.</p>
147
261
  <p><strong>Symptoms:</strong></p>
148
262
  <ul>
149
- <li>❌ Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
150
- <li>❌ New features aren&#39;t available despite updating</li>
151
- <li>❌ Bug fixes don&#39;t appear to be working</li>
152
- <li>❌ Version shown doesn&#39;t match npm registry</li>
263
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Running <code>npx @knowcode/doc-builder</code> shows an old version number</li>
264
+ <li><i class="ph ph-x-circle" aria-label="error"></i> New features aren&#39;t available despite updating</li>
265
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Bug fixes don&#39;t appear to be working</li>
266
+ <li><i class="ph ph-x-circle" aria-label="error"></i> Version shown doesn&#39;t match npm registry</li>
153
267
  </ul>
154
268
  <p><strong>Example:</strong></p>
155
269
  <pre><code class="language-bash">$ npx @knowcode/doc-builder@latest --version
@@ -171,7 +285,6 @@ npx @knowcode/doc-builder@1.4.22
171
285
  </code></pre>
172
286
  <h3>Why This Happens</h3>
173
287
  <div class="mermaid-wrapper">
174
- <div class="mermaid-title">Diagram</div>
175
288
  <div class="mermaid">graph TD
176
289
  A[Run npx @knowcode/doc-builder] --> B{Package in cache?}
177
290
  B -->|Yes| C[Use cached version]
@@ -213,10 +326,10 @@ npx doc-builder deploy # Uses local version
213
326
  </li>
214
327
  <li><p><strong>Ensure correct file extensions:</strong></p>
215
328
  <ul>
216
- <li>✅ <code>README.md</code></li>
217
- <li>✅ <code>guide.md</code></li>
218
- <li>❌ <code>README.txt</code></li>
219
- <li>❌ <code>guide.markdown</code></li>
329
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <code>README.md</code></li>
330
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <code>guide.md</code></li>
331
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>README.txt</code></li>
332
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>guide.markdown</code></li>
220
333
  </ul>
221
334
  </li>
222
335
  <li><p><strong>Use custom input directory:</strong></p>
@@ -296,9 +409,9 @@ npx @knowcode/doc-builder@latest set-production-url https://my-docs.vercel.app
296
409
  <ol>
297
410
  <li><p><strong>Check file name:</strong></p>
298
411
  <ul>
299
- <li>✅ <code>doc-builder.config.js</code></li>
300
- <li>❌ <code>docbuilder.config.js</code></li>
301
- <li>❌ <code>doc-builder-config.js</code></li>
412
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <code>doc-builder.config.js</code></li>
413
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>docbuilder.config.js</code></li>
414
+ <li><i class="ph ph-x-circle" aria-label="error"></i> <code>doc-builder-config.js</code></li>
302
415
  </ul>
303
416
  </li>
304
417
  <li><p><strong>Verify export format:</strong></p>
@@ -493,7 +606,17 @@ npm --version
493
606
  </div>
494
607
 
495
608
  <!-- Scripts -->
609
+ <script>
610
+ // Pass configuration to frontend
611
+ window.docBuilderConfig = {
612
+ features: {
613
+ showPdfDownload: true,
614
+ menuDefaultOpen: false
615
+ }
616
+ };
617
+ </script>
496
618
  <script src="/js/main.js"></script>
497
-
619
+ <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
620
+ <script src="/js/auth.js"></script>
498
621
  </body>
499
622
  </html>
package/html/guides/windows-setup-guide.html CHANGED
@@ -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="Beautiful documentation with the least effort possible">
7
- <title>Windows Setup Guide for Claude Code & @knowcode/doc-builder - @knowcode/doc-builder</title>
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 &amp; @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 &amp; @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 &amp; @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>📚</text></svg>">
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-28T10:31:53.227Z",
102
+ "dateModified": "2025-07-28T10:31:53.227Z",
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.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
141
+ <span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM 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,6 +205,7 @@
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>
@@ -101,7 +215,7 @@
101
215
  <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
216
  <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
217
  <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">
218
+ <div class="nav-section private-nav" data-level="1">
105
219
  <a class="nav-title collapsible" href="#" data-target="nav-private-1" >
106
220
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
107
221
  </a>
@@ -114,7 +228,7 @@
114
228
  <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
229
  <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
230
  <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">
231
+ <div class="nav-section private-nav" data-level="2">
118
232
  <a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
119
233
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
120
234
  </a>
@@ -144,17 +258,17 @@
144
258
  <h2>Quick Prerequisites Overview</h2>
145
259
  <p><strong>Required Accounts:</strong></p>
146
260
  <ul>
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>
261
+ <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>
262
+ <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>
263
+ <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
264
  </ul>
151
265
  <p><strong>Required Software:</strong></p>
152
266
  <ul>
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>
267
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Windows 10/11 with Administrator access</li>
268
+ <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>
269
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Git for Windows - <a href="https://gitforwindows.org">gitforwindows.org</a></li>
270
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> PowerShell 5.1+ (included with Windows)</li>
271
+ <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
272
  </ul>
159
273
  <h2>Understanding Claude vs Claude Code</h2>
160
274
  <h3>What&#39;s the Difference?</h3>
@@ -249,37 +363,37 @@
249
363
  <td><strong>Windows</strong></td>
250
364
  <td>10 or 11</td>
251
365
  <td>Operating system</td>
252
- <td>✅ Required</td>
366
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
253
367
  </tr>
254
368
  <tr>
255
369
  <td><strong>Node.js</strong></td>
256
370
  <td>14.0+</td>
257
371
  <td>JavaScript runtime</td>
258
- <td>✅ Required</td>
372
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
259
373
  </tr>
260
374
  <tr>
261
375
  <td><strong>npm</strong></td>
262
376
  <td>(included)</td>
263
377
  <td>Package manager</td>
264
- <td>✅ Required</td>
378
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
265
379
  </tr>
266
380
  <tr>
267
381
  <td><strong>Git</strong></td>
268
382
  <td>Latest</td>
269
383
  <td>Version control</td>
270
- <td>✅ Required</td>
384
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
271
385
  </tr>
272
386
  <tr>
273
387
  <td><strong>PowerShell</strong></td>
274
388
  <td>5.1+</td>
275
389
  <td>Command line</td>
276
- <td>✅ Required</td>
390
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Required</td>
277
391
  </tr>
278
392
  <tr>
279
393
  <td><strong>VS Code</strong></td>
280
394
  <td>Latest</td>
281
395
  <td>Code editor</td>
282
- <td>⭐ Recommended</td>
396
+ <td><i class="ph ph-star" aria-label="star"></i> Recommended</td>
283
397
  </tr>
284
398
  </tbody></table>
285
399
  <h3>Administrative Requirements</h3>
@@ -359,7 +473,7 @@
359
473
  </li>
360
474
  </ul>
361
475
  <h2>Step 1: Enable PowerShell Script Execution</h2>
362
- <p><strong>⚠️ IMPORTANT</strong>: This must be done FIRST as Administrator</p>
476
+ <p><strong><i class="ph ph-warning-circle" aria-label="warning"></i> IMPORTANT</strong>: This must be done FIRST as Administrator</p>
363
477
  <h3>Open PowerShell as Administrator</h3>
364
478
  <ol>
365
479
  <li>Press <code>Windows + X</code></li>
@@ -381,11 +495,11 @@
381
495
  <li>Go to <a href="https://nodejs.org/en/download/">Node.js Downloads</a></li>
382
496
  <li>Download the <strong>Windows Installer (.msi)</strong> for your system (64-bit recommended)</li>
383
497
  <li>Run the installer with these settings:<ul>
384
- <li>✅ Accept the license agreement</li>
385
- <li>✅ Default installation location</li>
386
- <li>✅ <strong>IMPORTANT</strong>: Ensure &quot;npm package manager&quot; is checked</li>
387
- <li>✅ Add to PATH (should be checked by default)</li>
388
- <li>✅ Automatically install necessary tools (optional but recommended)</li>
498
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Accept the license agreement</li>
499
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Default installation location</li>
500
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>IMPORTANT</strong>: Ensure &quot;npm package manager&quot; is checked</li>
501
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Add to PATH (should be checked by default)</li>
502
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Automatically install necessary tools (optional but recommended)</li>
389
503
  </ul>
390
504
  </li>
391
505
  </ol>
@@ -408,11 +522,11 @@ npm -v
408
522
  <li>Go to <a href="https://gitforwindows.org/">Git for Windows</a></li>
409
523
  <li>Download the installer</li>
410
524
  <li>Run with these recommended settings:<ul>
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&#39; default console window</li>
525
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Use Visual Studio Code as default editor</li>
526
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Git from the command line and also from 3rd-party software</li>
527
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Use bundled OpenSSH</li>
528
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Checkout Windows-style, commit Unix-style line endings</li>
529
+ <li><i class="ph ph-check-circle" aria-label="checked"></i> Use Windows&#39; default console window</li>
416
530
  </ul>
417
531
  </li>
418
532
  </ol>
@@ -434,19 +548,19 @@ npm -v
434
548
  <tbody><tr>
435
549
  <td><strong>Free</strong></td>
436
550
  <td>$0/month</td>
437
- <td>❌ No access</td>
551
+ <td><i class="ph ph-x-circle" aria-label="error"></i> No access</td>
438
552
  <td>Basic chat only</td>
439
553
  </tr>
440
554
  <tr>
441
555
  <td><strong>Pro</strong></td>
442
556
  <td>$20/month</td>
443
- <td>✅ Full access</td>
557
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
444
558
  <td>Individual developers</td>
445
559
  </tr>
446
560
  <tr>
447
561
  <td><strong>Max</strong></td>
448
562
  <td>$200/month</td>
449
- <td>✅ Full access</td>
563
+ <td><i class="ph ph-check-circle" aria-label="checked"></i> Full access</td>
450
564
  <td>Power users, higher limits</td>
451
565
  </tr>
452
566
  </tbody></table>
@@ -628,10 +742,10 @@ vercel login
628
742
  </ol>
629
743
  <p><strong>Solution</strong>:<br>Use a valid project name following these rules:</p>
630
744
  <ul>
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
+ <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>
746
+ <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
747
  <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> ✅, <code>my---docs</code> ❌</li>
748
+ <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
749
  </ul>
636
750
  <p><strong>Examples of valid names</strong>:</p>
637
751
  <ul>
@@ -718,7 +832,17 @@ npm cache clean --force
718
832
  </div>
719
833
 
720
834
  <!-- Scripts -->
835
+ <script>
836
+ // Pass configuration to frontend
837
+ window.docBuilderConfig = {
838
+ features: {
839
+ showPdfDownload: true,
840
+ menuDefaultOpen: false
841
+ }
842
+ };
843
+ </script>
721
844
  <script src="/js/main.js"></script>
722
-
845
+ <script src="https://unpkg.com/@supabase/supabase-js@2"></script>
846
+ <script src="/js/auth.js"></script>
723
847
  </body>
724
848
  </html>