@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.
- package/CHANGELOG.md +29 -0
- package/README.md +1 -0
- package/html/README.html +150 -33
- package/html/css/notion-style.css +394 -13
- package/html/documentation-index.html +128 -10
- package/html/guides/authentication-default-change.html +131 -7
- package/html/guides/authentication-guide.html +142 -19
- package/html/guides/claude-workflow-guide.html +138 -22
- package/html/guides/documentation-standards.html +134 -11
- package/html/guides/html-embedding-guide.html +450 -0
- package/html/guides/image-modal-guide.html +133 -10
- package/html/guides/phosphor-icons-guide.html +151 -27
- package/html/guides/private-directory-authentication.html +131 -7
- package/html/guides/public-site-deployment.html +131 -7
- package/html/guides/search-engine-verification-guide.html +131 -7
- package/html/guides/seo-guide.html +131 -7
- package/html/guides/seo-optimization-guide.html +160 -38
- package/html/guides/troubleshooting-guide.html +142 -19
- package/html/guides/windows-setup-guide.html +162 -38
- package/html/image-modal-test.html +126 -8
- package/html/index.html +150 -33
- package/html/js/auth.js +118 -39
- package/html/js/main.js +259 -25
- package/html/private/cache-control-anti-pattern.html +136 -12
- package/html/private/launch/README.html +145 -15
- package/html/private/launch/auth-cleanup-summary.html +154 -24
- package/html/private/launch/bubble-plugin-specification.html +137 -7
- package/html/private/launch/go-to-market-strategy.html +139 -9
- package/html/private/launch/launch-announcements.html +153 -24
- package/html/private/launch/vercel-deployment-auth-setup.html +139 -9
- package/html/private/next-steps-walkthrough.html +138 -14
- package/html/private/supabase-auth-implementation-completed.html +144 -21
- package/html/private/supabase-auth-implementation-plan.html +137 -14
- package/html/private/supabase-auth-integration-plan.html +143 -21
- package/html/private/supabase-auth-setup-guide.html +140 -16
- package/html/private/test-private-doc.html +131 -7
- package/html/private/user-management-tooling.html +131 -7
- package/html/prompts/markdown-document-standards.html +135 -12
- package/html/sitemap.xml +58 -46
- package/html/vercel-cli-setup-guide.html +129 -11
- package/html/vercel-first-time-setup-guide.html +126 -8
- package/lib/config.js +2 -0
- 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>Image Modal Test
|
|
6
|
+
<meta name="description" content="This document tests the new image modal functionality in doc-builder.">
|
|
7
|
+
<title>Image Modal Test | @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, 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">
|
|
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,84 @@
|
|
|
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": "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-28T10:31:53.228Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.228Z",
|
|
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>
|
|
23
126
|
</head>
|
|
24
127
|
<body>
|
|
25
128
|
<!-- Header -->
|
|
@@ -29,10 +132,14 @@
|
|
|
29
132
|
|
|
30
133
|
<div class="header-actions">
|
|
31
134
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
135
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM UTC</span>
|
|
33
136
|
</div>
|
|
34
137
|
|
|
35
138
|
|
|
139
|
+
<a href="../login.html" class="auth-btn" title="Login/Logout">
|
|
140
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
141
|
+
</a>
|
|
142
|
+
|
|
36
143
|
|
|
37
144
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
145
|
<i class="fas fa-moon"></i>
|
|
@@ -74,7 +181,7 @@
|
|
|
74
181
|
<nav class="navigation">
|
|
75
182
|
|
|
76
183
|
<div class="nav-section" data-level="0">
|
|
77
|
-
<a class="nav-title
|
|
184
|
+
<a class="nav-title" href="/README.html" >
|
|
78
185
|
<i class="fas fa-home"></i> Documentation
|
|
79
186
|
</a>
|
|
80
187
|
<div class="nav-content" >
|
|
@@ -92,6 +199,7 @@
|
|
|
92
199
|
<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
200
|
<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
201
|
<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>
|
|
202
|
+
<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
203
|
<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
204
|
<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
205
|
<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 +209,7 @@
|
|
|
101
209
|
<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
210
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
103
211
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
104
|
-
<div class="nav-section" data-level="1">
|
|
212
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
213
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
214
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
215
|
</a>
|
|
@@ -114,7 +222,7 @@
|
|
|
114
222
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
115
223
|
<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
224
|
<a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
117
|
-
<div class="nav-section" data-level="2">
|
|
225
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
226
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
227
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
228
|
</a>
|
|
@@ -183,7 +291,17 @@
|
|
|
183
291
|
</div>
|
|
184
292
|
|
|
185
293
|
<!-- Scripts -->
|
|
294
|
+
<script>
|
|
295
|
+
// Pass configuration to frontend
|
|
296
|
+
window.docBuilderConfig = {
|
|
297
|
+
features: {
|
|
298
|
+
showPdfDownload: true,
|
|
299
|
+
menuDefaultOpen: false
|
|
300
|
+
}
|
|
301
|
+
};
|
|
302
|
+
</script>
|
|
186
303
|
<script src="/js/main.js"></script>
|
|
187
|
-
|
|
304
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
305
|
+
<script src="/js/auth.js"></script>
|
|
188
306
|
</body>
|
|
189
307
|
</html>
|
package/html/index.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="
|
|
7
|
-
<title>@knowcode/doc-builder
|
|
6
|
+
<meta name="description" content="<div align="center">">
|
|
7
|
+
<title>@knowcode/doc-builder | @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, width, table">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/README.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/README.html">
|
|
17
|
+
<meta property="og:title" content="@knowcode/doc-builder | @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="<div align="center">">
|
|
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="@knowcode/doc-builder | @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="<div align="center">">
|
|
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,84 @@
|
|
|
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": "@knowcode/doc-builder",
|
|
91
|
+
"description": "<div align=\"center\">",
|
|
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.167Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.167Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/README.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": "README",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/README.html"
|
|
121
|
+
}
|
|
122
|
+
]
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
</script>
|
|
23
126
|
</head>
|
|
24
127
|
<body>
|
|
25
128
|
<!-- Header -->
|
|
@@ -29,10 +132,14 @@
|
|
|
29
132
|
|
|
30
133
|
<div class="header-actions">
|
|
31
134
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
135
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM UTC</span>
|
|
33
136
|
</div>
|
|
34
137
|
|
|
35
138
|
|
|
139
|
+
<a href="../login.html" class="auth-btn" title="Login/Logout">
|
|
140
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
141
|
+
</a>
|
|
142
|
+
|
|
36
143
|
|
|
37
144
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
145
|
<i class="fas fa-moon"></i>
|
|
@@ -92,6 +199,7 @@
|
|
|
92
199
|
<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
200
|
<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
201
|
<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>
|
|
202
|
+
<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
203
|
<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
204
|
<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
205
|
<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 +209,7 @@
|
|
|
101
209
|
<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
210
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
103
211
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
104
|
-
<div class="nav-section" data-level="1">
|
|
212
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
213
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
106
214
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
215
|
</a>
|
|
@@ -114,7 +222,7 @@
|
|
|
114
222
|
<a href="/private/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
|
|
115
223
|
<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
224
|
<a href="/private/user-management-tooling.html" class="nav-item" data-tooltip="The user management system is a set of tools designed to manage user access to Supabase-authenticated documentation sites built with."><i class="fas fa-file-alt"></i> User Management Tooling</a></div></div>
|
|
117
|
-
<div class="nav-section" data-level="2">
|
|
225
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
226
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
227
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
228
|
</a>
|
|
@@ -145,26 +253,26 @@
|
|
|
145
253
|
<p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
|
|
146
254
|
</blockquote>
|
|
147
255
|
<p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><img src="https://img.shields.io/npm/v/@knowcode/doc-builder" alt="npm version"></a><br><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a></p>
|
|
148
|
-
<h3
|
|
256
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h3>
|
|
149
257
|
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
150
258
|
</code></pre>
|
|
151
259
|
<p><a href="https://doc-builder-delta.vercel.app"><strong>You are looking at a demo</strong></a> | <a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>NPM Package</strong></a> | <a href="https://github.com/wapdat/doc-builder"><strong>GitHub</strong></a></p>
|
|
152
260
|
</div>
|
|
153
261
|
|
|
154
262
|
<hr>
|
|
155
|
-
<h2
|
|
263
|
+
<h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
|
|
156
264
|
<table>
|
|
157
265
|
<tr>
|
|
158
266
|
<td width="50%">
|
|
159
267
|
|
|
160
|
-
<h3
|
|
268
|
+
<h3><i class="ph ph-palette" aria-label="design"></i> Design & UX</h3>
|
|
161
269
|
<ul>
|
|
162
270
|
<li><strong>Notion-inspired UI</strong> - Clean, modern interface</li>
|
|
163
271
|
<li><strong>Dark mode support</strong> - Automatic theme switching</li>
|
|
164
272
|
<li><strong>Responsive layout</strong> - Perfect on any device</li>
|
|
165
273
|
<li><strong>Syntax highlighting</strong> - Beautiful code blocks</li>
|
|
166
274
|
</ul>
|
|
167
|
-
<h3
|
|
275
|
+
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Navigation</h3>
|
|
168
276
|
<ul>
|
|
169
277
|
<li><strong>Full-text search</strong> - Find anything instantly</li>
|
|
170
278
|
<li><strong>Smart navigation</strong> - Hierarchical structure</li>
|
|
@@ -174,14 +282,14 @@
|
|
|
174
282
|
</td>
|
|
175
283
|
<td width="50%">
|
|
176
284
|
|
|
177
|
-
<h3
|
|
285
|
+
<h3><i class="ph ph-chart-bar" aria-label="chart"></i> Content Support</h3>
|
|
178
286
|
<ul>
|
|
179
287
|
<li><strong>Mermaid diagrams</strong> - Visual documentation</li>
|
|
180
288
|
<li><strong>GitHub markdown</strong> - Full GFM support</li>
|
|
181
289
|
<li><strong>Interactive tooltips</strong> - Document previews</li>
|
|
182
290
|
<li><strong>Version tracking</strong> - Build metadata</li>
|
|
183
291
|
</ul>
|
|
184
|
-
<h3
|
|
292
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Deployment</h3>
|
|
185
293
|
<ul>
|
|
186
294
|
<li><strong>One-command deploy</strong> - Push to Vercel</li>
|
|
187
295
|
<li><strong>Static generation</strong> - Fast & secure</li>
|
|
@@ -192,7 +300,7 @@
|
|
|
192
300
|
</tr>
|
|
193
301
|
</table>
|
|
194
302
|
|
|
195
|
-
<h2
|
|
303
|
+
<h2><i class="ph ph-target" aria-label="goal"></i> Use Cases</h2>
|
|
196
304
|
<table>
|
|
197
305
|
<tr>
|
|
198
306
|
<td width="25%">
|
|
@@ -218,7 +326,7 @@
|
|
|
218
326
|
</tr>
|
|
219
327
|
</table>
|
|
220
328
|
|
|
221
|
-
<h2
|
|
329
|
+
<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
|
|
222
330
|
<table>
|
|
223
331
|
<tr>
|
|
224
332
|
<td width="50%">
|
|
@@ -238,7 +346,7 @@
|
|
|
238
346
|
</tr>
|
|
239
347
|
</table>
|
|
240
348
|
|
|
241
|
-
<h2
|
|
349
|
+
<h2><i class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
|
|
242
350
|
<p>Configuration is fully managed through the CLI tools - no manual file editing required! The tool handles all settings automatically during setup and deployment.</p>
|
|
243
351
|
<table>
|
|
244
352
|
<tr>
|
|
@@ -273,14 +381,13 @@ features: {
|
|
|
273
381
|
</tr>
|
|
274
382
|
</table>
|
|
275
383
|
|
|
276
|
-
<h2
|
|
384
|
+
<h2><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Examples</h2>
|
|
277
385
|
<table>
|
|
278
386
|
<tr>
|
|
279
387
|
<td width="50%">
|
|
280
388
|
|
|
281
389
|
<h3>Mermaid Diagrams</h3>
|
|
282
390
|
<div class="mermaid-wrapper">
|
|
283
|
-
<div class="mermaid-title">Diagram</div>
|
|
284
391
|
<div class="mermaid">graph LR
|
|
285
392
|
A[Write] --> B[Build]
|
|
286
393
|
B --> C[Deploy]
|
|
@@ -305,12 +412,12 @@ docBuilder.build({
|
|
|
305
412
|
</tr>
|
|
306
413
|
</table>
|
|
307
414
|
|
|
308
|
-
<h2
|
|
415
|
+
<h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why Choose doc-builder?</h2>
|
|
309
416
|
<table>
|
|
310
417
|
<tr>
|
|
311
418
|
<td width="33%">
|
|
312
419
|
|
|
313
|
-
<h3
|
|
420
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Performance</h3>
|
|
314
421
|
<ul>
|
|
315
422
|
<li><strong>Lightning fast</strong> - Static generation</li>
|
|
316
423
|
<li><strong>SEO optimized</strong> - Search friendly</li>
|
|
@@ -319,7 +426,7 @@ docBuilder.build({
|
|
|
319
426
|
</td>
|
|
320
427
|
<td width="33%">
|
|
321
428
|
|
|
322
|
-
<h3
|
|
429
|
+
<h3><i class="ph ph-gear-six" aria-label="tools"></i> Developer Experience</h3>
|
|
323
430
|
<ul>
|
|
324
431
|
<li><strong>Zero config</strong> - Works instantly</li>
|
|
325
432
|
<li><strong>Version control</strong> - Git-friendly</li>
|
|
@@ -328,7 +435,7 @@ docBuilder.build({
|
|
|
328
435
|
</td>
|
|
329
436
|
<td width="33%">
|
|
330
437
|
|
|
331
|
-
<h3
|
|
438
|
+
<h3><i class="ph ph-money" aria-label="money"></i> Cost Effective</h3>
|
|
332
439
|
<ul>
|
|
333
440
|
<li><strong>Free hosting</strong> - Vercel free tier</li>
|
|
334
441
|
<li><strong>No vendor lock-in</strong> - Your content</li>
|
|
@@ -338,7 +445,7 @@ docBuilder.build({
|
|
|
338
445
|
</tr>
|
|
339
446
|
</table>
|
|
340
447
|
|
|
341
|
-
<h2
|
|
448
|
+
<h2><i class="ph ph-handshake" aria-label="partnership"></i> Get Involved</h2>
|
|
342
449
|
<table>
|
|
343
450
|
<tr>
|
|
344
451
|
<td width="50%">
|
|
@@ -347,10 +454,10 @@ docBuilder.build({
|
|
|
347
454
|
<p>We welcome contributions! Check our <a href="https://github.com/wapdat/doc-builder">contribution guide</a> to get started.</p>
|
|
348
455
|
<p><strong>Ways to help:</strong></p>
|
|
349
456
|
<ul>
|
|
350
|
-
<li
|
|
351
|
-
<li
|
|
352
|
-
<li
|
|
353
|
-
<li
|
|
457
|
+
<li><i class="ph ph-bug" aria-label="bug"></i> Report bugs</li>
|
|
458
|
+
<li><i class="ph ph-lightbulb" aria-label="idea"></i> Suggest features</li>
|
|
459
|
+
<li><i class="ph ph-note-pencil" aria-label="edit"></i> Improve docs</li>
|
|
460
|
+
<li><i class="ph ph-wrench" aria-label="settings"></i> Submit PRs</li>
|
|
354
461
|
</ul>
|
|
355
462
|
</td>
|
|
356
463
|
<td width="50%">
|
|
@@ -359,10 +466,10 @@ docBuilder.build({
|
|
|
359
466
|
<p>Join our growing community of documentation enthusiasts!</p>
|
|
360
467
|
<p><strong>Connect with us:</strong></p>
|
|
361
468
|
<ul>
|
|
362
|
-
<li
|
|
363
|
-
<li
|
|
364
|
-
<li
|
|
365
|
-
<li
|
|
469
|
+
<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
470
|
+
<li><i class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
|
|
471
|
+
<li><i class="ph ph-globe" aria-label="global"></i> <a href="https://knowcode.com">Website</a></li>
|
|
472
|
+
<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
|
|
366
473
|
</ul>
|
|
367
474
|
</td>
|
|
368
475
|
</tr>
|
|
@@ -371,8 +478,8 @@ docBuilder.build({
|
|
|
371
478
|
<hr>
|
|
372
479
|
<div align="center">
|
|
373
480
|
|
|
374
|
-
<h3
|
|
375
|
-
<p>Built with
|
|
481
|
+
<h3><i class="ph ph-note-pencil" aria-label="edit"></i> License: MIT © KnowCode</h3>
|
|
482
|
+
<p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
|
|
376
483
|
<p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>Get Started</strong></a> | <a href="https://doc-builder-delta.vercel.app"><strong>You are looking at a demo</strong></a> | <a href="https://github.com/wapdat/doc-builder"><strong>Star on GitHub</strong></a></p>
|
|
377
484
|
</div>
|
|
378
485
|
|
|
@@ -381,7 +488,17 @@ docBuilder.build({
|
|
|
381
488
|
</div>
|
|
382
489
|
|
|
383
490
|
<!-- Scripts -->
|
|
491
|
+
<script>
|
|
492
|
+
// Pass configuration to frontend
|
|
493
|
+
window.docBuilderConfig = {
|
|
494
|
+
features: {
|
|
495
|
+
showPdfDownload: true,
|
|
496
|
+
menuDefaultOpen: false
|
|
497
|
+
}
|
|
498
|
+
};
|
|
499
|
+
</script>
|
|
384
500
|
<script src="/js/main.js"></script>
|
|
385
|
-
|
|
501
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
502
|
+
<script src="/js/auth.js"></script>
|
|
386
503
|
</body>
|
|
387
504
|
</html>
|