@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>Vercel Deployment Authentication Setup Guide
|
|
6
|
+
<meta name="description" content="Your test documentation site is now live at:">
|
|
7
|
+
<title>Vercel Deployment Authentication Setup Guide</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, supabase, authentication">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/private/launch/vercel-deployment-auth-setup.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/private/launch/vercel-deployment-auth-setup.html">
|
|
17
|
+
<meta property="og:title" content="Vercel Deployment Authentication Setup Guide">
|
|
18
|
+
<meta property="og:description" content="Your test documentation site is now live at:">
|
|
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 Deployment Authentication Setup Guide">
|
|
28
|
+
<meta name="twitter:description" content="Your test documentation site is now live at:">
|
|
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,96 @@
|
|
|
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 Deployment Authentication Setup Guide",
|
|
91
|
+
"description": "Your test documentation site is now live at:",
|
|
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.244Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.244Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/private/launch/vercel-deployment-auth-setup.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": "Private",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/private/"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"@type": "ListItem",
|
|
124
|
+
"position": 3,
|
|
125
|
+
"name": "Launch",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/private/launch/"
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"@type": "ListItem",
|
|
130
|
+
"position": 4,
|
|
131
|
+
"name": "Vercel Deployment Auth Setup",
|
|
132
|
+
"item": "https://doc-builder-delta.vercel.app/private/launch/vercel-deployment-auth-setup.html"
|
|
133
|
+
}
|
|
134
|
+
]
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
</script>
|
|
23
138
|
</head>
|
|
24
139
|
<body>
|
|
25
140
|
<!-- Header -->
|
|
@@ -29,10 +144,14 @@
|
|
|
29
144
|
|
|
30
145
|
<div class="header-actions">
|
|
31
146
|
<div class="deployment-info">
|
|
32
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
147
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.1">Last updated: Jul 28, 2025, 10:31 AM UTC</span>
|
|
33
148
|
</div>
|
|
34
149
|
|
|
35
150
|
|
|
151
|
+
<a href="../../../login.html" class="auth-btn" title="Login/Logout">
|
|
152
|
+
<i class="fas fa-sign-in-alt"></i>
|
|
153
|
+
</a>
|
|
154
|
+
|
|
36
155
|
|
|
37
156
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
38
157
|
<i class="fas fa-moon"></i>
|
|
@@ -92,6 +211,7 @@
|
|
|
92
211
|
<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
212
|
<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
213
|
<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>
|
|
214
|
+
<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
215
|
<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
216
|
<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
217
|
<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 +221,7 @@
|
|
|
101
221
|
<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
222
|
<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
223
|
<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">
|
|
224
|
+
<div class="nav-section private-nav" data-level="1">
|
|
105
225
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
106
226
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
107
227
|
</a>
|
|
@@ -114,7 +234,7 @@
|
|
|
114
234
|
<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
235
|
<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
236
|
<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">
|
|
237
|
+
<div class="nav-section private-nav" data-level="2">
|
|
118
238
|
<a class="nav-title collapsible expanded" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
119
239
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
120
240
|
</a>
|
|
@@ -191,7 +311,7 @@ WHERE da.domain = 'doc-builder-2znroyb5z-lindsay-1340s-projects.vercel.app&#
|
|
|
191
311
|
<li>After successful login, you should see the test documentation content</li>
|
|
192
312
|
</ol>
|
|
193
313
|
<h2>Step 3: Verify Authentication Features</h2>
|
|
194
|
-
<h3
|
|
314
|
+
<h3><i class="ph ph-check-circle" aria-label="checked"></i> What Should Work:</h3>
|
|
195
315
|
<ul>
|
|
196
316
|
<li>Automatic redirect to login for unauthenticated users</li>
|
|
197
317
|
<li>No content flash before redirect (fixed with CSS)</li>
|
|
@@ -200,7 +320,7 @@ WHERE da.domain = 'doc-builder-2znroyb5z-lindsay-1340s-projects.vercel.app&#
|
|
|
200
320
|
<li>Logout functionality</li>
|
|
201
321
|
<li>Session persistence across page refreshes</li>
|
|
202
322
|
</ul>
|
|
203
|
-
<h3
|
|
323
|
+
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Things to Check:</h3>
|
|
204
324
|
<ol>
|
|
205
325
|
<li><strong>Network Tab</strong>: Look for Supabase API calls to verify authentication</li>
|
|
206
326
|
<li><strong>Console</strong>: Check for any JavaScript errors</li>
|
|
@@ -270,7 +390,17 @@ npx @knowcode/doc-builder auth:add-user production-email@example.com
|
|
|
270
390
|
</div>
|
|
271
391
|
|
|
272
392
|
<!-- Scripts -->
|
|
393
|
+
<script>
|
|
394
|
+
// Pass configuration to frontend
|
|
395
|
+
window.docBuilderConfig = {
|
|
396
|
+
features: {
|
|
397
|
+
showPdfDownload: true,
|
|
398
|
+
menuDefaultOpen: false
|
|
399
|
+
}
|
|
400
|
+
};
|
|
401
|
+
</script>
|
|
273
402
|
<script src="/js/main.js"></script>
|
|
274
|
-
|
|
403
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
404
|
+
<script src="/js/auth.js"></script>
|
|
275
405
|
</body>
|
|
276
406
|
</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>Next Steps: Testing and Deployment Walkthrough
|
|
6
|
+
<meta name="description" content="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment. This guide provides detailed,...">
|
|
7
|
+
<title>Next Steps: Testing and Deployment Walkthrough</title>
|
|
8
|
+
|
|
9
|
+
<meta name="author" content="Lindsay Smith">
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, test, step">
|
|
11
|
+
<meta name="robots" content="index, follow">
|
|
12
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/private/next-steps-walkthrough.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/private/next-steps-walkthrough.html">
|
|
17
|
+
<meta property="og:title" content="Next Steps: Testing and Deployment Walkthrough">
|
|
18
|
+
<meta property="og:description" content="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment. This guide provides detailed,...">
|
|
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="Next Steps: Testing and Deployment Walkthrough">
|
|
28
|
+
<meta name="twitter:description" content="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment. This guide provides detailed,...">
|
|
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": "Next Steps: Testing and Deployment Walkthrough",
|
|
91
|
+
"description": "Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment. This guide provides detailed,...",
|
|
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.248Z",
|
|
102
|
+
"dateModified": "2025-07-28T10:31:53.248Z",
|
|
103
|
+
"mainEntityOfPage": {
|
|
104
|
+
"@type": "WebPage",
|
|
105
|
+
"@id": "https://doc-builder-delta.vercel.app/private/next-steps-walkthrough.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": "Private",
|
|
120
|
+
"item": "https://doc-builder-delta.vercel.app/private/"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"@type": "ListItem",
|
|
124
|
+
"position": 3,
|
|
125
|
+
"name": "Next Steps Walkthrough",
|
|
126
|
+
"item": "https://doc-builder-delta.vercel.app/private/next-steps-walkthrough.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.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" 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 expanded" 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>
|
|
@@ -141,7 +255,7 @@
|
|
|
141
255
|
<h1>Next Steps: Testing and Deployment Walkthrough</h1>
|
|
142
256
|
<h2>Overview</h2>
|
|
143
257
|
<p>Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment. This guide provides detailed, step-by-step instructions.</p>
|
|
144
|
-
<h2
|
|
258
|
+
<h2><i class="ph ph-test-tube" aria-label="test"></i> Phase 1: Local Testing</h2>
|
|
145
259
|
<h3>Step 1: Install Dependencies</h3>
|
|
146
260
|
<p>First, install the new Supabase dependency:</p>
|
|
147
261
|
<pre><code class="language-bash">cd /Users/lindsaysmith/Documents/lambda1.nosync/doc-builder
|
|
@@ -307,7 +421,7 @@ VALUES ('USER_ID_FROM_STEP_10', 'localhost:3001');
|
|
|
307
421
|
<li><strong>Should see the test content</strong></li>
|
|
308
422
|
<li><strong>Logout should work</strong></li>
|
|
309
423
|
</ol>
|
|
310
|
-
<h2
|
|
424
|
+
<h2><i class="ph ph-rocket-launch" aria-label="launch"></i> Phase 2: Deployment Testing</h2>
|
|
311
425
|
<h3>Step 13: Test Vercel Deployment</h3>
|
|
312
426
|
<ol>
|
|
313
427
|
<li><strong>Update config for deployment</strong>:</li>
|
|
@@ -362,7 +476,7 @@ UPDATE docbuilder_sites
|
|
|
362
476
|
SET domain = 'your-vercel-url.vercel.app'
|
|
363
477
|
WHERE id = 'your-site-id';
|
|
364
478
|
</code></pre>
|
|
365
|
-
<h2
|
|
479
|
+
<h2><i class="ph ph-wrench" aria-label="settings"></i> Phase 3: Version Management</h2>
|
|
366
480
|
<h3>Step 15: Update Version Number</h3>
|
|
367
481
|
<ol>
|
|
368
482
|
<li><strong>Update package.json</strong>:</li>
|
|
@@ -422,7 +536,7 @@ npm install ../doc-builder/*.tgz
|
|
|
422
536
|
npx doc-builder --version
|
|
423
537
|
npx doc-builder --help
|
|
424
538
|
</code></pre>
|
|
425
|
-
<h2
|
|
539
|
+
<h2><i class="ph ph-clipboard-text" aria-label="clipboard"></i> Phase 4: Quality Assurance</h2>
|
|
426
540
|
<h3>Step 17: Test All CLI Commands</h3>
|
|
427
541
|
<pre><code class="language-bash"># Test help
|
|
428
542
|
node cli.js --help
|
|
@@ -460,7 +574,7 @@ grep -r "username.*:" test-html/ || echo "Good - no hardcoded use
|
|
|
460
574
|
<h3>Step 19: Cross-Platform Testing</h3>
|
|
461
575
|
<p>If possible, test on different systems:</p>
|
|
462
576
|
<ul>
|
|
463
|
-
<li><strong>macOS</strong>: Current system
|
|
577
|
+
<li><strong>macOS</strong>: Current system <i class="ph ph-check-circle" aria-label="checked"></i></li>
|
|
464
578
|
<li><strong>Windows</strong>: Test in WSL or Windows machine</li>
|
|
465
579
|
<li><strong>Linux</strong>: Test in Docker or Linux VM</li>
|
|
466
580
|
</ul>
|
|
@@ -479,7 +593,7 @@ find docs/ -name "*.md" -exec grep -l "]\(" {} \;
|
|
|
479
593
|
</ul>
|
|
480
594
|
</li>
|
|
481
595
|
</ol>
|
|
482
|
-
<h2
|
|
596
|
+
<h2><i class="ph ph-target" aria-label="goal"></i> Success Criteria Checklist</h2>
|
|
483
597
|
<p>Before considering deployment ready:</p>
|
|
484
598
|
<h3>Functionality</h3>
|
|
485
599
|
<ul>
|
|
@@ -513,7 +627,7 @@ find docs/ -name "*.md" -exec grep -l "]\(" {} \;
|
|
|
513
627
|
<li><input disabled="" type="checkbox"> Environment variable support</li>
|
|
514
628
|
<li><input disabled="" type="checkbox"> Cross-platform functionality</li>
|
|
515
629
|
</ul>
|
|
516
|
-
<h2
|
|
630
|
+
<h2><i class="ph ph-siren" aria-label="alert"></i> Issues to Watch For</h2>
|
|
517
631
|
<h3>Common Problems</h3>
|
|
518
632
|
<ol>
|
|
519
633
|
<li><strong>Supabase URL format errors</strong> - Must be <code>https://xxx.supabase.co</code></li>
|
|
@@ -538,7 +652,17 @@ find docs/ -name "*.md" -exec grep -l "]\(" {} \;
|
|
|
538
652
|
</div>
|
|
539
653
|
|
|
540
654
|
<!-- Scripts -->
|
|
655
|
+
<script>
|
|
656
|
+
// Pass configuration to frontend
|
|
657
|
+
window.docBuilderConfig = {
|
|
658
|
+
features: {
|
|
659
|
+
showPdfDownload: true,
|
|
660
|
+
menuDefaultOpen: false
|
|
661
|
+
}
|
|
662
|
+
};
|
|
663
|
+
</script>
|
|
541
664
|
<script src="/js/main.js"></script>
|
|
542
|
-
|
|
665
|
+
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
666
|
+
<script src="/js/auth.js"></script>
|
|
543
667
|
</body>
|
|
544
668
|
</html>
|