@knowcode/doc-builder 1.8.7 → 1.9.1
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/.claude/settings.local.json +2 -1
- package/CHANGELOG.md +27 -0
- package/README.md +2 -0
- package/assets/css/notion-style.css +141 -0
- package/assets/js/main.js +76 -0
- package/html/README.html +41 -149
- package/html/css/notion-style.css +13 -253
- package/html/documentation-index.html +24 -127
- package/html/guides/authentication-default-change.html +15 -130
- package/html/guides/authentication-guide.html +27 -141
- package/html/guides/claude-workflow-guide.html +30 -137
- package/html/guides/documentation-standards.html +19 -133
- package/html/guides/image-modal-guide.html +381 -0
- package/html/guides/phosphor-icons-guide.html +35 -150
- package/html/guides/private-directory-authentication.html +15 -130
- package/html/guides/public-site-deployment.html +15 -130
- package/html/guides/search-engine-verification-guide.html +15 -130
- package/html/guides/seo-guide.html +15 -130
- package/html/guides/seo-optimization-guide.html +46 -159
- package/html/guides/troubleshooting-guide.html +27 -141
- package/html/guides/windows-setup-guide.html +46 -161
- package/html/image-modal-test.html +189 -0
- package/html/index.html +41 -149
- package/html/js/auth.js +39 -118
- package/html/js/main.js +25 -183
- package/html/private/cache-control-anti-pattern.html +20 -135
- package/html/private/launch/README.html +23 -144
- package/html/private/launch/auth-cleanup-summary.html +32 -153
- package/html/private/launch/bubble-plugin-specification.html +15 -136
- package/html/private/launch/go-to-market-strategy.html +17 -138
- package/html/private/launch/launch-announcements.html +31 -151
- package/html/private/launch/vercel-deployment-auth-setup.html +17 -138
- package/html/private/next-steps-walkthrough.html +21 -136
- package/html/private/supabase-auth-implementation-completed.html +29 -143
- package/html/private/supabase-auth-implementation-plan.html +22 -136
- package/html/private/supabase-auth-integration-plan.html +29 -142
- package/html/private/supabase-auth-setup-guide.html +24 -139
- package/html/private/test-private-doc.html +15 -130
- package/html/private/user-management-tooling.html +15 -130
- package/html/prompts/markdown-document-standards.html +288 -0
- package/html/sitemap.xml +56 -44
- package/html/vercel-cli-setup-guide.html +19 -128
- package/html/vercel-first-time-setup-guide.html +16 -125
- package/lib/core-builder.js +1 -0
- package/lib/emoji-mapper.js +25 -0
- package/package/assets/css/notion-style.css +432 -135
- package/package/assets/js/main.js +259 -25
- package/package.json +1 -1
|
@@ -3,41 +3,14 @@
|
|
|
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>Launch Announcement Templates
|
|
8
|
-
|
|
9
|
-
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, doc, builder">
|
|
11
|
-
<meta name="robots" content="index, follow">
|
|
12
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/private/launch/launch-announcements.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/launch-announcements.html">
|
|
17
|
-
<meta property="og:title" content="Launch Announcement Templates | @knowcode/doc-builder">
|
|
18
|
-
<meta property="og:description" content="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.">
|
|
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="Launch Announcement Templates | @knowcode/doc-builder">
|
|
28
|
-
<meta name="twitter:description" content="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.">
|
|
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">
|
|
6
|
+
<meta name="description" content="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Launch Announcement Templates - @knowcode/doc-builder</title>
|
|
34
8
|
|
|
35
9
|
<!-- Fonts -->
|
|
36
10
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
37
11
|
|
|
38
12
|
<!-- Icons -->
|
|
39
13
|
<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">
|
|
41
14
|
|
|
42
15
|
<!-- Mermaid -->
|
|
43
16
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -45,96 +18,8 @@
|
|
|
45
18
|
<!-- Styles -->
|
|
46
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
47
20
|
|
|
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
|
-
|
|
83
21
|
<!-- Favicon -->
|
|
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
|
|
85
|
-
|
|
86
|
-
<script type="application/ld+json">
|
|
87
|
-
{
|
|
88
|
-
"@context": "https://schema.org",
|
|
89
|
-
"@type": "TechArticle",
|
|
90
|
-
"headline": "Launch Announcement Templates",
|
|
91
|
-
"description": "This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.",
|
|
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-26T16:10:10.642Z",
|
|
102
|
-
"dateModified": "2025-07-26T16:10:10.642Z",
|
|
103
|
-
"mainEntityOfPage": {
|
|
104
|
-
"@type": "WebPage",
|
|
105
|
-
"@id": "https://doc-builder-delta.vercel.app/private/launch/launch-announcements.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": "Launch Announcements",
|
|
132
|
-
"item": "https://doc-builder-delta.vercel.app/private/launch/launch-announcements.html"
|
|
133
|
-
}
|
|
134
|
-
]
|
|
135
|
-
}
|
|
136
|
-
}
|
|
137
|
-
</script>
|
|
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>">
|
|
138
23
|
</head>
|
|
139
24
|
<body>
|
|
140
25
|
<!-- Header -->
|
|
@@ -144,14 +29,10 @@
|
|
|
144
29
|
|
|
145
30
|
<div class="header-actions">
|
|
146
31
|
<div class="deployment-info">
|
|
147
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
148
33
|
</div>
|
|
149
34
|
|
|
150
35
|
|
|
151
|
-
<a href="../../../login.html" class="auth-btn" title="Login/Logout">
|
|
152
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
153
|
-
</a>
|
|
154
|
-
|
|
155
36
|
|
|
156
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
157
38
|
<i class="fas fa-moon"></i>
|
|
@@ -199,6 +80,7 @@
|
|
|
199
80
|
<div class="nav-content" >
|
|
200
81
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
201
82
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
83
|
+
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
|
|
202
84
|
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
203
85
|
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
204
86
|
<div class="nav-section" data-level="1">
|
|
@@ -210,6 +92,7 @@
|
|
|
210
92
|
<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>
|
|
211
93
|
<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>
|
|
212
94
|
<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>
|
|
95
|
+
<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>
|
|
213
96
|
<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>
|
|
214
97
|
<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>
|
|
215
98
|
<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>
|
|
@@ -218,7 +101,7 @@
|
|
|
218
101
|
<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>
|
|
219
102
|
<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>
|
|
220
103
|
<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>
|
|
221
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
222
105
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
223
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
224
107
|
</a>
|
|
@@ -231,7 +114,7 @@
|
|
|
231
114
|
<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>
|
|
232
115
|
<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>
|
|
233
116
|
<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>
|
|
234
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
235
118
|
<a class="nav-title collapsible expanded" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
236
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
237
120
|
</a>
|
|
@@ -242,6 +125,12 @@
|
|
|
242
125
|
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
243
126
|
<a href="/private/launch/launch-announcements.html" class="nav-item active" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a>
|
|
244
127
|
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
128
|
+
<div class="nav-section" data-level="1">
|
|
129
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
130
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
|
|
131
|
+
</a>
|
|
132
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
133
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
|
|
245
134
|
</nav>
|
|
246
135
|
<div class="resize-handle"></div>
|
|
247
136
|
</aside>
|
|
@@ -268,7 +157,7 @@
|
|
|
268
157
|
<li>The output rarely looked professional</li>
|
|
269
158
|
</ul>
|
|
270
159
|
<p><strong>The Solution:</strong><br>Doc Builder transforms your markdown files into beautiful, searchable documentation sites with a single command. Think Notion meets documentation generator.</p>
|
|
271
|
-
<p><strong>Key Features:</strong><br
|
|
160
|
+
<p><strong>Key Features:</strong><br>✨ <strong>Notion-inspired design</strong> - Clean, modern UI that readers love<br>🚀 <strong>One-command deployment</strong> - <code>npx @knowcode/doc-builder@latest deploy</code><br>🔍 <strong>Full-text search</strong> - Find anything instantly<br>🌓 <strong>Dark mode</strong> - Easy on the eyes<br>📊 <strong>Mermaid diagrams</strong> - Visualize complex concepts<br>🔐 <strong>Password protection</strong> - Keep internal docs secure<br>📱 <strong>Fully responsive</strong> - Perfect on any device</p>
|
|
272
161
|
<p><strong>Perfect for:</strong></p>
|
|
273
162
|
<ul>
|
|
274
163
|
<li>Open source projects</li>
|
|
@@ -320,7 +209,7 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
320
209
|
<p>The code is MIT licensed. Would love feedback from the HN community!</p>
|
|
321
210
|
<h2>Twitter/X Thread</h2>
|
|
322
211
|
<h3>Thread</h3>
|
|
323
|
-
<p>🧵 1/7<br>Just launched Doc Builder - a tool that transforms your markdown into beautiful documentation sites with ONE command
|
|
212
|
+
<p>🧵 1/7<br>Just launched Doc Builder - a tool that transforms your markdown into beautiful documentation sites with ONE command 🚀</p>
|
|
324
213
|
<p>No more hours of setup. No more ugly docs.</p>
|
|
325
214
|
<p>npx @knowcode/doc-builder@latest deploy</p>
|
|
326
215
|
<p>That's it. You're live on Vercel.</p>
|
|
@@ -332,7 +221,7 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
332
221
|
<li>Costs too much for small projects</li>
|
|
333
222
|
</ul>
|
|
334
223
|
<p>I needed something better.</p>
|
|
335
|
-
<p>3/7<br>Doc Builder features:<br
|
|
224
|
+
<p>3/7<br>Doc Builder features:<br>✨ Notion-inspired design<br>🔍 Full-text search built-in<br>🌓 Automatic dark mode<br>📊 Mermaid diagram support<br>🔐 Optional password protection<br>📱 Mobile responsive<br>⚡ Lightning fast (static HTML)</p>
|
|
336
225
|
<p>4/7<br>Perfect for:</p>
|
|
337
226
|
<ul>
|
|
338
227
|
<li>Open source projects</li>
|
|
@@ -359,11 +248,11 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
359
248
|
<p>#buildinpublic #documentation #webdev #opensource</p>
|
|
360
249
|
<h2>LinkedIn Post</h2>
|
|
361
250
|
<h3>Post</h3>
|
|
362
|
-
<p
|
|
251
|
+
<p>🎉 Excited to announce the launch of Doc Builder - a developer tool that transforms markdown documentation into beautiful, searchable websites with just one command.</p>
|
|
363
252
|
<p><strong>The Challenge:</strong><br>As developers, we spend countless hours setting up documentation frameworks, configuring build tools, and wrestling with deployment pipelines. Time that could be better spent actually writing documentation or building features.</p>
|
|
364
253
|
<p><strong>The Solution:</strong><br>Doc Builder eliminates this complexity. With a single command, you can deploy professional-looking documentation to Vercel:</p>
|
|
365
254
|
<p><code>npx @knowcode/doc-builder@latest deploy</code></p>
|
|
366
|
-
<p><strong>Key Benefits:</strong><br>•
|
|
255
|
+
<p><strong>Key Benefits:</strong><br>• ⏱️ Save hours of setup time<br>• 🎨 Professional Notion-inspired design out of the box<br>• 🔍 Built-in search functionality<br>• 🌓 Automatic dark mode support<br>• 📊 Mermaid diagram integration<br>• 🔐 Optional password protection<br>• 📱 Fully responsive design</p>
|
|
367
256
|
<p><strong>Who It's For:</strong><br>• Open source maintainers<br>• API developers<br>• Technical writers<br>• Development teams<br>• Anyone who needs beautiful documentation quickly</p>
|
|
368
257
|
<p><strong>Impact So Far:</strong><br>• 21 releases on npm<br>• Active community of early adopters<br>• Used in production by multiple projects</p>
|
|
369
258
|
<p>Try the live demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></p>
|
|
@@ -415,19 +304,20 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
415
304
|
</code></pre>
|
|
416
305
|
<p>That's it! Your documentation is now live on Vercel with a public URL.</p>
|
|
417
306
|
<h2>Key Features That Make It Special</h2>
|
|
418
|
-
<h3
|
|
307
|
+
<h3>🎨 Beautiful by Default</h3>
|
|
419
308
|
<p>I spent weeks perfecting the design so you don't have to. The Notion-inspired interface is clean, modern, and professional.</p>
|
|
420
|
-
<h3
|
|
309
|
+
<h3>🔍 Search That Actually Works</h3>
|
|
421
310
|
<p>Full-text search is built-in. No configuration needed. It just works.</p>
|
|
422
311
|
<h3>🌓 Dark Mode</h3>
|
|
423
312
|
<p>Automatic theme detection with manual toggle. Your readers' eyes will thank you.</p>
|
|
424
|
-
<h3
|
|
313
|
+
<h3>📊 Mermaid Diagrams</h3>
|
|
425
314
|
<div class="mermaid-wrapper">
|
|
315
|
+
<div class="mermaid-title">Diagram</div>
|
|
426
316
|
<div class="mermaid">graph TD
|
|
427
317
|
A[Write Markdown] --> B[Run Deploy]
|
|
428
318
|
B --> C[Live Documentation]</div>
|
|
429
319
|
</div>
|
|
430
|
-
<h3
|
|
320
|
+
<h3>🔐 Password Protection</h3>
|
|
431
321
|
<p>Need private docs? Enable authentication with one config line:</p>
|
|
432
322
|
<pre><code class="language-javascript">features: {
|
|
433
323
|
authentication: true
|
|
@@ -477,9 +367,9 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
477
367
|
<p>If you're tired of spending more time on documentation setup than actual writing, give it a try. I'd love to hear your feedback!</p>
|
|
478
368
|
<p><strong>Links:</strong></p>
|
|
479
369
|
<ul>
|
|
480
|
-
<li
|
|
481
|
-
<li
|
|
482
|
-
<li
|
|
370
|
+
<li>🚀 <a href="https://doc-builder-delta.vercel.app">Live Demo</a></li>
|
|
371
|
+
<li>📦 <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
372
|
+
<li>🐙 <a href="https://github.com/knowcode/doc-builder">GitHub Repo</a> (coming soon)</li>
|
|
483
373
|
</ul>
|
|
484
374
|
<p>What's your biggest documentation pain point? Let me know in the comments!</p>
|
|
485
375
|
<h2>Reddit Posts</h2>
|
|
@@ -542,14 +432,14 @@ await build({
|
|
|
542
432
|
<p>Learned a lot building this, happy to answer technical questions!</p>
|
|
543
433
|
<h2>Email Newsletter</h2>
|
|
544
434
|
<h3>Subject</h3>
|
|
545
|
-
<p
|
|
435
|
+
<p>🚀 Introducing Doc Builder: Beautiful Documentation in One Command</p>
|
|
546
436
|
<h3>Body</h3>
|
|
547
437
|
<p>Hi {firstName},</p>
|
|
548
438
|
<p>Remember the last time you spent hours setting up documentation for a project?</p>
|
|
549
439
|
<p>The configuring, the styling, the deployment scripts... What if I told you all of that could be replaced with a single command?</p>
|
|
550
440
|
<p><strong>Introducing Doc Builder</strong></p>
|
|
551
441
|
<p>I built Doc Builder because I was tired of documentation taking longer to set up than to write. It's a simple tool that:</p>
|
|
552
|
-
<p
|
|
442
|
+
<p>✅ Converts your markdown to beautiful, searchable websites<br>✅ Deploys to Vercel with zero configuration<br>✅ Looks professional out of the box (Notion-inspired design)<br>✅ Includes dark mode, search, and syntax highlighting</p>
|
|
553
443
|
<p><strong>See It In Action</strong></p>
|
|
554
444
|
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
555
445
|
</code></pre>
|
|
@@ -578,7 +468,7 @@ doc-builder deploy
|
|
|
578
468
|
<p>Questions? Just reply to this email. I personally read every message.</p>
|
|
579
469
|
<p>Happy documenting!</p>
|
|
580
470
|
<p>Best,<br>Lindsay Smith<br>Creator of Doc Builder</p>
|
|
581
|
-
<p>P.S. Doc Builder is open source and MIT licensed. If you find it useful, a GitHub star would mean the world to me!
|
|
471
|
+
<p>P.S. Doc Builder is open source and MIT licensed. If you find it useful, a GitHub star would mean the world to me! 🌟</p>
|
|
582
472
|
<hr>
|
|
583
473
|
<h2>Press Release</h2>
|
|
584
474
|
<h3>FOR IMMEDIATE RELEASE</h3>
|
|
@@ -631,17 +521,7 @@ doc-builder deploy
|
|
|
631
521
|
</div>
|
|
632
522
|
|
|
633
523
|
<!-- Scripts -->
|
|
634
|
-
<script>
|
|
635
|
-
// Pass configuration to frontend
|
|
636
|
-
window.docBuilderConfig = {
|
|
637
|
-
features: {
|
|
638
|
-
showPdfDownload: true,
|
|
639
|
-
menuDefaultOpen: false
|
|
640
|
-
}
|
|
641
|
-
};
|
|
642
|
-
</script>
|
|
643
524
|
<script src="/js/main.js"></script>
|
|
644
|
-
|
|
645
|
-
<script src="/js/auth.js"></script>
|
|
525
|
+
|
|
646
526
|
</body>
|
|
647
527
|
</html>
|
|
@@ -3,41 +3,14 @@
|
|
|
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</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">
|
|
6
|
+
<meta name="description" content="Beautiful documentation with the least effort possible">
|
|
7
|
+
<title>Vercel Deployment Authentication Setup Guide - @knowcode/doc-builder</title>
|
|
34
8
|
|
|
35
9
|
<!-- Fonts -->
|
|
36
10
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
37
11
|
|
|
38
12
|
<!-- Icons -->
|
|
39
13
|
<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">
|
|
41
14
|
|
|
42
15
|
<!-- Mermaid -->
|
|
43
16
|
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
@@ -45,96 +18,8 @@
|
|
|
45
18
|
<!-- Styles -->
|
|
46
19
|
<link rel="stylesheet" href="/css/notion-style.css">
|
|
47
20
|
|
|
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
|
-
|
|
83
21
|
<!-- Favicon -->
|
|
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
|
|
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-26T16:10:10.644Z",
|
|
102
|
-
"dateModified": "2025-07-26T16:10:10.644Z",
|
|
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>
|
|
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>">
|
|
138
23
|
</head>
|
|
139
24
|
<body>
|
|
140
25
|
<!-- Header -->
|
|
@@ -144,14 +29,10 @@
|
|
|
144
29
|
|
|
145
30
|
<div class="header-actions">
|
|
146
31
|
<div class="deployment-info">
|
|
147
|
-
<span class="deployment-date" title="Built with doc-builder v1.
|
|
32
|
+
<span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 27, 2025, 08:32 AM UTC</span>
|
|
148
33
|
</div>
|
|
149
34
|
|
|
150
35
|
|
|
151
|
-
<a href="../../../login.html" class="auth-btn" title="Login/Logout">
|
|
152
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
153
|
-
</a>
|
|
154
|
-
|
|
155
36
|
|
|
156
37
|
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
157
38
|
<i class="fas fa-moon"></i>
|
|
@@ -199,6 +80,7 @@
|
|
|
199
80
|
<div class="nav-content" >
|
|
200
81
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
201
82
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
83
|
+
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="fas fa-file-alt"></i> Image Modal Test</a>
|
|
202
84
|
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
203
85
|
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
204
86
|
<div class="nav-section" data-level="1">
|
|
@@ -210,6 +92,7 @@
|
|
|
210
92
|
<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>
|
|
211
93
|
<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>
|
|
212
94
|
<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>
|
|
95
|
+
<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>
|
|
213
96
|
<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>
|
|
214
97
|
<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>
|
|
215
98
|
<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>
|
|
@@ -218,7 +101,7 @@
|
|
|
218
101
|
<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>
|
|
219
102
|
<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>
|
|
220
103
|
<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>
|
|
221
|
-
<div class="nav-section
|
|
104
|
+
<div class="nav-section" data-level="1">
|
|
222
105
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
223
106
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Private
|
|
224
107
|
</a>
|
|
@@ -231,7 +114,7 @@
|
|
|
231
114
|
<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>
|
|
232
115
|
<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>
|
|
233
116
|
<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>
|
|
234
|
-
<div class="nav-section
|
|
117
|
+
<div class="nav-section" data-level="2">
|
|
235
118
|
<a class="nav-title collapsible expanded" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
236
119
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
237
120
|
</a>
|
|
@@ -242,6 +125,12 @@
|
|
|
242
125
|
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
243
126
|
<a href="/private/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a>
|
|
244
127
|
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item active" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
128
|
+
<div class="nav-section" data-level="1">
|
|
129
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
130
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Prompts
|
|
131
|
+
</a>
|
|
132
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
133
|
+
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="fas fa-file-alt"></i> Markdown Document Standards</a></div></div>
|
|
245
134
|
</nav>
|
|
246
135
|
<div class="resize-handle"></div>
|
|
247
136
|
</aside>
|
|
@@ -302,7 +191,7 @@ WHERE da.domain = 'doc-builder-2znroyb5z-lindsay-1340s-projects.vercel.app&#
|
|
|
302
191
|
<li>After successful login, you should see the test documentation content</li>
|
|
303
192
|
</ol>
|
|
304
193
|
<h2>Step 3: Verify Authentication Features</h2>
|
|
305
|
-
<h3
|
|
194
|
+
<h3>✅ What Should Work:</h3>
|
|
306
195
|
<ul>
|
|
307
196
|
<li>Automatic redirect to login for unauthenticated users</li>
|
|
308
197
|
<li>No content flash before redirect (fixed with CSS)</li>
|
|
@@ -311,7 +200,7 @@ WHERE da.domain = 'doc-builder-2znroyb5z-lindsay-1340s-projects.vercel.app&#
|
|
|
311
200
|
<li>Logout functionality</li>
|
|
312
201
|
<li>Session persistence across page refreshes</li>
|
|
313
202
|
</ul>
|
|
314
|
-
<h3
|
|
203
|
+
<h3>🔍 Things to Check:</h3>
|
|
315
204
|
<ol>
|
|
316
205
|
<li><strong>Network Tab</strong>: Look for Supabase API calls to verify authentication</li>
|
|
317
206
|
<li><strong>Console</strong>: Check for any JavaScript errors</li>
|
|
@@ -381,17 +270,7 @@ npx @knowcode/doc-builder auth:add-user production-email@example.com
|
|
|
381
270
|
</div>
|
|
382
271
|
|
|
383
272
|
<!-- Scripts -->
|
|
384
|
-
<script>
|
|
385
|
-
// Pass configuration to frontend
|
|
386
|
-
window.docBuilderConfig = {
|
|
387
|
-
features: {
|
|
388
|
-
showPdfDownload: true,
|
|
389
|
-
menuDefaultOpen: false
|
|
390
|
-
}
|
|
391
|
-
};
|
|
392
|
-
</script>
|
|
393
273
|
<script src="/js/main.js"></script>
|
|
394
|
-
|
|
395
|
-
<script src="/js/auth.js"></script>
|
|
274
|
+
|
|
396
275
|
</body>
|
|
397
276
|
</html>
|