@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>Vercel First-Time Setup Guide
|
|
6
|
+
<meta name="description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
|
|
7
|
+
<title>Vercel First-Time Setup Guide | @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, your, deployment">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/vercel-first-time-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/vercel-first-time-setup-guide.html">
|
|
17
|
+
<meta property="og:title" content="Vercel First-Time Setup Guide | @knowcode/doc-builder">
|
|
18
|
+
<meta property="og:description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
|
|
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="Vercel First-Time Setup Guide | @knowcode/doc-builder">
|
|
28
|
+
<meta name="twitter:description" content="This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.">
|
|
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": "Vercel First-Time Setup Guide",
|
|
91
|
+
"description": "This guide walks you through the Vercel deployment process when using `@knowcode/doc-builder deploy`.",
|
|
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.987Z",
|
|
102
|
+
"dateModified": "2025-07-28T16:34:27.987Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/vercel-first-time-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": "Vercel First Time Setup Guide",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.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.3">Last updated: Jul 28, 2025, 04:34 PM 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,16 +199,18 @@
|
|
|
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>
|
|
206
|
+
<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
207
|
<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
208
|
<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
209
|
<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
210
|
<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
211
|
<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
212
|
<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">
|
|
213
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
214
|
<a class="nav-title collapsible" href="#" data-target="nav-private-1" >
|
|
106
215
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
216
|
</a>
|
|
@@ -114,7 +223,7 @@
|
|
|
114
223
|
<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
224
|
<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
225
|
<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">
|
|
226
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
227
|
<a class="nav-title collapsible" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
228
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
229
|
</a>
|
|
@@ -319,7 +428,17 @@
|
|
|
319
428
|
</div>
|
|
320
429
|
|
|
321
430
|
<!-- Scripts -->
|
|
431
|
+
<script>
|
|
432
|
+
// Pass configuration to frontend
|
|
433
|
+
window.docBuilderConfig = {
|
|
434
|
+
features: {
|
|
435
|
+
showPdfDownload: true,
|
|
436
|
+
menuDefaultOpen: false
|
|
437
|
+
}
|
|
438
|
+
};
|
|
439
|
+
</script>
|
|
322
440
|
<script src="/js/main.js"></script>
|
|
323
|
-
|
|
441
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
442
|
+
<script src="/js/auth.js"></script>
|
|
324
443
|
</body>
|
|
325
444
|
</html>
|
package/lib/config.js
CHANGED
package/lib/emoji-mapper.js
CHANGED
|
@@ -62,6 +62,8 @@ const emojiToPhosphor = {
|
|
|
62
62
|
'✒️': '<i class="ph ph-pen" aria-label="write"></i>',
|
|
63
63
|
'🖊️': '<i class="ph ph-pen-nib" aria-label="pen"></i>',
|
|
64
64
|
'🖋️': '<i class="ph ph-pen-nib-straight" aria-label="fountain pen"></i>',
|
|
65
|
+
'🏷️': '<i class="ph ph-tag" aria-label="tag"></i>',
|
|
66
|
+
'👁️': '<i class="ph ph-eye" aria-label="view"></i>',
|
|
65
67
|
'📐': '<i class="ph ph-ruler" aria-label="measure"></i>',
|
|
66
68
|
'📏': '<i class="ph ph-ruler" aria-label="ruler"></i>',
|
|
67
69
|
|
package/lib/supabase-auth.js
CHANGED
|
@@ -87,16 +87,17 @@ class SupabaseAuth {
|
|
|
87
87
|
if (isPrivatePage) {
|
|
88
88
|
showAccessDenied();
|
|
89
89
|
} else {
|
|
90
|
-
// Public page,
|
|
91
|
-
document.body.classList.add('authenticated');
|
|
90
|
+
// Public page, show it but don't grant private navigation access
|
|
91
|
+
document.body.classList.add('authenticated'); // Show body content
|
|
92
92
|
updateAuthButton(false);
|
|
93
93
|
}
|
|
94
94
|
return;
|
|
95
95
|
}
|
|
96
96
|
|
|
97
|
-
// User is authenticated and has access
|
|
97
|
+
// User is authenticated and has domain access - grant full access including private nav
|
|
98
98
|
console.log('User authenticated and authorized');
|
|
99
99
|
document.body.classList.add('authenticated');
|
|
100
|
+
document.body.classList.add('has-private-access'); // Grant private navigation access
|
|
100
101
|
updateAuthButton(true);
|
|
101
102
|
|
|
102
103
|
} catch (error) {
|