@knowcode/doc-builder 1.9.29 → 1.9.31
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/assets/js/main.js +7 -0
- package/lib/core-builder.js +18 -1
- package/package.json +12 -2
- package/.claude/settings.local.json +0 -56
- package/CACHE-BUSTING-GUIDE.md +0 -82
- package/CLAUDE.md +0 -86
- package/CONTRIBUTING.md +0 -148
- package/GITHUB_SETUP.md +0 -203
- package/RELEASE-NOTES-1.7.5.md +0 -64
- package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
- package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
- package/add-user-clive.sql +0 -35
- package/add-user-lindsay-fixed.sql +0 -85
- package/add-user-lindsay.sql +0 -68
- package/add-user-pmorgan.sql +0 -35
- package/add-user-robbie.sql +0 -35
- package/add-wru-users.sql +0 -105
- package/debug-login.sql +0 -30
- package/doc-builder.config.js +0 -126
- package/doc-builder.config.js.backup.1753793768283 +0 -47
- package/doc-builder.config.js.backup.1753803964423 +0 -114
- package/doc-builder.config.js.backup.1753945707032 +0 -115
- package/doc-builder.config.js.backup.1754059241330 +0 -115
- package/doc-builder.config.js.backup.1754119567787 +0 -123
- package/doc-builder.config.js.backup.1754120048862 +0 -124
- package/doc-builder.config.js.backup.1754120529913 +0 -124
- package/doc-builder.config.js.backup.1754218469785 +0 -124
- package/doc-builder.config.js.backup.1754384764054 +0 -124
- package/doc-builder.config.js.backup.1754567425847 +0 -124
- package/doc-builder.config.js.backup.1754568137859 +0 -126
- package/doc-builder.config.js.backup.1754569388252 +0 -126
- package/doc-builder.config.js.backup.1754576694123 +0 -126
- package/doc-builder.config.js.backup.1755031374829 +0 -126
- package/doc-builder.config.js.backup.1755034500990 +0 -126
- package/grant-access.sql +0 -15
- package/html/11.png +0 -0
- package/html/404.html +0 -115
- package/html/README.html +0 -522
- package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
- package/html/about-doc-builder.html +0 -491
- package/html/auth.js +0 -157
- package/html/claude-workflow-guide.html +0 -525
- package/html/css/notion-style.css +0 -2502
- package/html/documentation-index.html +0 -471
- package/html/guides/authentication-default-change.html +0 -370
- package/html/guides/authentication-guide.html +0 -509
- package/html/guides/cache-control-anti-pattern.html +0 -361
- package/html/guides/claude-workflow-guide.html +0 -1074
- package/html/guides/configuration-guide.html +0 -472
- package/html/guides/document-standards.html +0 -518
- package/html/guides/documentation-standards.html +0 -694
- package/html/guides/html-embedding-guide.html +0 -461
- package/html/guides/image-modal-guide.html +0 -515
- package/html/guides/next-steps-walkthrough.html +0 -638
- package/html/guides/phosphor-icons-guide.html +0 -584
- package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
- package/html/guides/private-directory-authentication.html +0 -541
- package/html/guides/public-site-deployment.html +0 -431
- package/html/guides/search-engine-verification-guide.html +0 -542
- package/html/guides/seo-guide.html +0 -661
- package/html/guides/seo-optimization-guide.html +0 -887
- package/html/guides/supabase-auth-implementation-plan.html +0 -543
- package/html/guides/supabase-auth-integration-plan.html +0 -671
- package/html/guides/supabase-auth-setup-guide.html +0 -498
- package/html/guides/supabase-authentication-complete-guide.html +0 -866
- package/html/guides/troubleshooting-guide.html +0 -633
- package/html/guides/vercel-deployment-auth-setup.html +0 -337
- package/html/guides/windows-setup-guide.html +0 -859
- package/html/image-modal-test.html +0 -318
- package/html/index.html +0 -522
- package/html/js/auth.js +0 -157
- package/html/js/main.js +0 -1747
- package/html/launch/README.html +0 -297
- package/html/launch/bubble-plugin-specification.html +0 -933
- package/html/launch/go-to-market-strategy.html +0 -663
- package/html/launch/launch-announcements.html +0 -593
- package/html/login.html +0 -102
- package/html/logout.html +0 -18
- package/html/private/cache-control-anti-pattern.html +0 -429
- package/html/private/launch/README.html +0 -371
- package/html/private/launch/auth-cleanup-summary.html +0 -361
- package/html/private/launch/bubble-plugin-specification.html +0 -1007
- package/html/private/launch/go-to-market-strategy.html +0 -737
- package/html/private/launch/launch-announcements.html +0 -667
- package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
- package/html/private/next-steps-walkthrough.html +0 -679
- package/html/private/supabase-auth-implementation-completed.html +0 -454
- package/html/private/supabase-auth-implementation-plan.html +0 -594
- package/html/private/supabase-auth-integration-plan.html +0 -704
- package/html/private/supabase-auth-setup-guide.html +0 -555
- package/html/private/test-private-doc.html +0 -302
- package/html/private/user-management-tooling.html +0 -601
- package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
- package/html/prompts/beautiful-documentation-design.html +0 -784
- package/html/prompts/markdown-document-standards.html +0 -422
- package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
- package/html/robots.txt +0 -9
- package/html/sitemap.xml +0 -357
- package/html/test-questions/how-does-it-work%3F.html +0 -294
- package/html/test-questions/step-1%3A%20getting-started.html +0 -289
- package/html/test-questions/what-is-the-purpose.html +0 -293
- package/html/test-status.html +0 -281
- package/html/vercel-cli-setup-guide.html +0 -495
- package/html/vercel-first-time-setup-guide.html +0 -454
- package/html/vercel.json +0 -29
- package/html-static/11.png +0 -0
- package/html-static/404.html +0 -115
- package/html-static/README.html +0 -599
- package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
- package/html-static/about-doc-builder.html +0 -568
- package/html-static/css/notion-style.css +0 -2502
- package/html-static/documentation-index.html +0 -548
- package/html-static/guides/authentication-default-change.html +0 -447
- package/html-static/guides/authentication-guide.html +0 -586
- package/html-static/guides/claude-workflow-guide.html +0 -1151
- package/html-static/guides/configuration-guide.html +0 -549
- package/html-static/guides/documentation-standards.html +0 -771
- package/html-static/guides/html-embedding-guide.html +0 -538
- package/html-static/guides/image-modal-guide.html +0 -592
- package/html-static/guides/phosphor-icons-guide.html +0 -661
- package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -632
- package/html-static/guides/private-directory-authentication.html +0 -618
- package/html-static/guides/public-site-deployment.html +0 -508
- package/html-static/guides/search-engine-verification-guide.html +0 -619
- package/html-static/guides/seo-guide.html +0 -738
- package/html-static/guides/seo-optimization-guide.html +0 -964
- package/html-static/guides/supabase-authentication-complete-guide.html +0 -943
- package/html-static/guides/troubleshooting-guide.html +0 -710
- package/html-static/guides/windows-setup-guide.html +0 -936
- package/html-static/image-modal-test.html +0 -395
- package/html-static/index.html +0 -599
- package/html-static/js/main.js +0 -1747
- package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
- package/html-static/prompts/beautiful-documentation-design.html +0 -861
- package/html-static/prompts/markdown-document-standards.html +0 -499
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -607
- package/html-static/robots.txt +0 -5
- package/html-static/sitemap.xml +0 -195
- package/html-static/test-questions/how-does-it-work%3F.html +0 -371
- package/html-static/test-questions/step-1%3A%20getting-started.html +0 -366
- package/html-static/test-questions/what-is-the-purpose.html +0 -370
- package/html-static/vercel-cli-setup-guide.html +0 -572
- package/html-static/vercel-first-time-setup-guide.html +0 -531
- package/manage-users.sql +0 -191
- package/migrate-to-domain-auth.sql +0 -47
- package/package/CACHE-BUSTING-GUIDE.md +0 -82
- package/package/CHANGELOG.md +0 -902
- package/package/README.md +0 -248
- package/package/assets/css/notion-style.css +0 -2211
- package/package/assets/js/auth.js +0 -67
- package/package/assets/js/main.js +0 -1565
- package/package/cli.js +0 -764
- package/package/index.js +0 -38
- package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
- package/package/lib/builder.js +0 -32
- package/package/lib/config.js +0 -278
- package/package/lib/core-builder.js +0 -957
- package/package/lib/deploy.js +0 -497
- package/package/lib/dev-server.js +0 -96
- package/package/package.json +0 -34
- package/package/scripts/npx-runner.js +0 -27
- package/package/scripts/setup.js +0 -56
- package/package/test-cache-bust.sh +0 -43
- package/public-config.js +0 -22
- package/public-html/404.html +0 -115
- package/public-html/README.html +0 -149
- package/public-html/css/notion-style.css +0 -2036
- package/public-html/index.html +0 -149
- package/public-html/js/auth.js +0 -67
- package/public-html/js/main.js +0 -1485
- package/quick-test-commands.md +0 -40
- package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
- package/recordings/mh-ls-22jul.txt +0 -2305
- package/screenshot.png +0 -0
- package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
- package/setup-database-v2.sql +0 -53
- package/setup-database.sql +0 -41
- package/test-auth-config.js +0 -17
- package/test-cache-bust.sh +0 -43
- package/test-docs/README.md +0 -39
- package/test-html/404.html +0 -115
- package/test-html/README.html +0 -172
- package/test-html/auth.js +0 -97
- package/test-html/css/notion-style.css +0 -2036
- package/test-html/index.html +0 -172
- package/test-html/js/auth.js +0 -97
- package/test-html/js/main.js +0 -1485
- package/test-html/login.html +0 -102
- package/test-html/logout.html +0 -18
- package/update-domain.sql +0 -9
- package/user-access-view.sql +0 -49
- package/user-management/README.md +0 -301
- package/user-management/add-users.sh +0 -776
- package/user-management/create-user.js +0 -65
- package/user-management/users.txt +0 -15
- package/view-all-users.sql +0 -40
- package/wru-auth-config.js +0 -17
|
@@ -1,667 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.">
|
|
7
|
-
<title>Launch Announcement Templates | @knowcode/doc-builder</title>
|
|
8
|
-
|
|
9
|
-
<meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
|
|
10
|
-
<meta name="author" content="Lindsay Smith">
|
|
11
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, doc, builder">
|
|
12
|
-
<meta name="robots" content="index, follow">
|
|
13
|
-
<link rel="canonical" href="https://doc-builder-delta.vercel.app/private/launch/launch-announcements.html">
|
|
14
|
-
|
|
15
|
-
<!-- Open Graph / Facebook -->
|
|
16
|
-
<meta property="og:type" content="article">
|
|
17
|
-
<meta property="og:url" content="https://doc-builder-delta.vercel.app/private/launch/launch-announcements.html">
|
|
18
|
-
<meta property="og:title" content="Launch Announcement Templates | @knowcode/doc-builder">
|
|
19
|
-
<meta property="og:description" content="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.">
|
|
20
|
-
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
21
|
-
<meta property="og:site_name" content="@knowcode/doc-builder">
|
|
22
|
-
<meta property="og:locale" content="en_US">
|
|
23
|
-
|
|
24
|
-
<!-- Twitter Card -->
|
|
25
|
-
<meta name="twitter:card" content="summary_large_image">
|
|
26
|
-
<meta name="twitter:site" content="@planbbackups">
|
|
27
|
-
<meta name="twitter:creator" content="@planbbackups">
|
|
28
|
-
<meta name="twitter:title" content="Launch Announcement Templates | @knowcode/doc-builder">
|
|
29
|
-
<meta name="twitter:description" content="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.">
|
|
30
|
-
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
31
|
-
|
|
32
|
-
<!-- Custom Meta Tags -->
|
|
33
|
-
<meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
|
|
34
|
-
<meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
|
|
35
|
-
|
|
36
|
-
<!-- Fonts -->
|
|
37
|
-
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
|
|
38
|
-
|
|
39
|
-
<!-- Icons -->
|
|
40
|
-
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
|
|
41
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
|
|
42
|
-
|
|
43
|
-
<!-- Mermaid -->
|
|
44
|
-
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
|
|
45
|
-
|
|
46
|
-
<!-- Styles -->
|
|
47
|
-
<link rel="stylesheet" href="/css/notion-style.css">
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
<!-- Hide content until auth check -->
|
|
53
|
-
<style>
|
|
54
|
-
body {
|
|
55
|
-
visibility: hidden;
|
|
56
|
-
opacity: 0;
|
|
57
|
-
transition: opacity 0.3s ease;
|
|
58
|
-
}
|
|
59
|
-
body.authenticated {
|
|
60
|
-
visibility: visible;
|
|
61
|
-
opacity: 1;
|
|
62
|
-
}
|
|
63
|
-
/* Show login/logout pages immediately */
|
|
64
|
-
body.auth-page {
|
|
65
|
-
visibility: visible;
|
|
66
|
-
opacity: 1;
|
|
67
|
-
}
|
|
68
|
-
/* Style auth button consistently */
|
|
69
|
-
.auth-btn {
|
|
70
|
-
background: none;
|
|
71
|
-
border: none;
|
|
72
|
-
color: var(--text-secondary);
|
|
73
|
-
cursor: pointer;
|
|
74
|
-
padding: 0.5rem;
|
|
75
|
-
border-radius: 0.5rem;
|
|
76
|
-
transition: all 0.2s;
|
|
77
|
-
font-size: 1.1rem;
|
|
78
|
-
}
|
|
79
|
-
.auth-btn:hover {
|
|
80
|
-
background: var(--bg-secondary);
|
|
81
|
-
color: var(--text-primary);
|
|
82
|
-
}
|
|
83
|
-
</style>
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
<!-- Favicon -->
|
|
87
|
-
<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>">
|
|
88
|
-
|
|
89
|
-
<script type="application/ld+json">
|
|
90
|
-
{
|
|
91
|
-
"@context": "https://schema.org",
|
|
92
|
-
"@type": "TechArticle",
|
|
93
|
-
"headline": "Launch Announcement Templates",
|
|
94
|
-
"description": "This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.",
|
|
95
|
-
"author": {
|
|
96
|
-
"@type": "Person",
|
|
97
|
-
"name": "Lindsay Smith"
|
|
98
|
-
},
|
|
99
|
-
"publisher": {
|
|
100
|
-
"@type": "Organization",
|
|
101
|
-
"name": "Knowcode Ltd",
|
|
102
|
-
"url": "https://knowcode.tech"
|
|
103
|
-
},
|
|
104
|
-
"datePublished": "2025-08-12T21:35:01.172Z",
|
|
105
|
-
"dateModified": "2025-08-12T21:35:01.172Z",
|
|
106
|
-
"mainEntityOfPage": {
|
|
107
|
-
"@type": "WebPage",
|
|
108
|
-
"@id": "https://doc-builder-delta.vercel.app/private/launch/launch-announcements.html"
|
|
109
|
-
},
|
|
110
|
-
"breadcrumb": {
|
|
111
|
-
"@type": "BreadcrumbList",
|
|
112
|
-
"itemListElement": [
|
|
113
|
-
{
|
|
114
|
-
"@type": "ListItem",
|
|
115
|
-
"position": 1,
|
|
116
|
-
"name": "@knowcode/doc-builder",
|
|
117
|
-
"item": "https://doc-builder-delta.vercel.app"
|
|
118
|
-
},
|
|
119
|
-
{
|
|
120
|
-
"@type": "ListItem",
|
|
121
|
-
"position": 2,
|
|
122
|
-
"name": "Private",
|
|
123
|
-
"item": "https://doc-builder-delta.vercel.app/private/"
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
"@type": "ListItem",
|
|
127
|
-
"position": 3,
|
|
128
|
-
"name": "Launch",
|
|
129
|
-
"item": "https://doc-builder-delta.vercel.app/private/launch/"
|
|
130
|
-
},
|
|
131
|
-
{
|
|
132
|
-
"@type": "ListItem",
|
|
133
|
-
"position": 4,
|
|
134
|
-
"name": "Launch Announcements",
|
|
135
|
-
"item": "https://doc-builder-delta.vercel.app/private/launch/launch-announcements.html"
|
|
136
|
-
}
|
|
137
|
-
]
|
|
138
|
-
}
|
|
139
|
-
}
|
|
140
|
-
</script>
|
|
141
|
-
</head>
|
|
142
|
-
<body>
|
|
143
|
-
|
|
144
|
-
<!-- Header -->
|
|
145
|
-
<header class="header">
|
|
146
|
-
<div class="header-content">
|
|
147
|
-
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
148
|
-
|
|
149
|
-
<div class="header-actions">
|
|
150
|
-
<div class="deployment-info">
|
|
151
|
-
<span class="deployment-date" title="Built with doc-builder v1.9.28">Last updated: Aug 12, 2025, 09:35 PM UTC</span>
|
|
152
|
-
</div>
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
<a href="../../../login.html" class="auth-btn" title="Login/Logout">
|
|
156
|
-
<i class="fas fa-sign-in-alt"></i>
|
|
157
|
-
</a>
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
161
|
-
<i class="fas fa-moon"></i>
|
|
162
|
-
</button>
|
|
163
|
-
|
|
164
|
-
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
165
|
-
<i class="fas fa-bars"></i>
|
|
166
|
-
</button>
|
|
167
|
-
</div>
|
|
168
|
-
</div>
|
|
169
|
-
</header>
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
<!-- Breadcrumbs -->
|
|
175
|
-
<nav class="breadcrumbs " id="breadcrumbs" >
|
|
176
|
-
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
177
|
-
</nav>
|
|
178
|
-
|
|
179
|
-
<!-- Main Content -->
|
|
180
|
-
<div class="main-wrapper">
|
|
181
|
-
<!-- Sidebar -->
|
|
182
|
-
<aside class="sidebar">
|
|
183
|
-
<div class="sidebar-header">
|
|
184
|
-
<div class="filter-box">
|
|
185
|
-
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
186
|
-
<i class="fas fa-search filter-icon"></i>
|
|
187
|
-
</div>
|
|
188
|
-
</div>
|
|
189
|
-
<nav class="navigation">
|
|
190
|
-
|
|
191
|
-
<div class="nav-section" data-level="0">
|
|
192
|
-
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
193
|
-
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
194
|
-
</a>
|
|
195
|
-
<div class="nav-content">
|
|
196
|
-
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
197
|
-
<a href="/about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
|
|
198
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
|
|
199
|
-
<a href="/image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
|
|
200
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Vercel Cli Setup Guide</a>
|
|
201
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Vercel First Time Setup Guide</a></div></div>
|
|
202
|
-
<div class="nav-section" data-level="1">
|
|
203
|
-
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
204
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
205
|
-
</a>
|
|
206
|
-
<div class="nav-content collapsed" id="nav-guides-1">
|
|
207
|
-
<a href="/guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
|
|
208
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Authentication Guide</a>
|
|
209
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
|
|
210
|
-
<a href="/guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #059669;"></i> Configuration Guide</a>
|
|
211
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
|
|
212
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Html Embedding Guide</a>
|
|
213
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Image Modal Guide</a>
|
|
214
|
-
<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="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
|
|
215
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication</a>
|
|
216
|
-
<a href="/guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #059669;"></i> Private Directory Authentication Troubleshooting</a>
|
|
217
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Public Site Deployment</a>
|
|
218
|
-
<a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #059669;"></i> Search Engine Verification Guide</a>
|
|
219
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Seo Guide</a>
|
|
220
|
-
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #059669;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
|
|
221
|
-
<a href="/guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Authentication Complete Guide</a>
|
|
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="ph ph-check-circle" style="color: #059669;"></i> Troubleshooting Guide</a>
|
|
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="ph ph-check-circle" style="color: #059669;"></i> Windows Setup Guide</a></div></div>
|
|
224
|
-
<div class="nav-section private-nav" data-level="1">
|
|
225
|
-
<a class="nav-title collapsible expanded" href="#" data-target="nav-private-1" >
|
|
226
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-lock"></i> Private
|
|
227
|
-
</a>
|
|
228
|
-
<div class="nav-content" id="nav-private-1">
|
|
229
|
-
<a href="/private/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="ph ph-check-circle" style="color: #059669;"></i> Cache Control Anti Pattern</a>
|
|
230
|
-
<a href="/private/next-steps-walkthrough.html" class="nav-item" data-tooltip="Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment."><i class="ph ph-check-circle" style="color: #059669;"></i> Next Steps Walkthrough</a>
|
|
231
|
-
<a href="/private/supabase-auth-implementation-completed.html" class="nav-item" data-tooltip="This document records the successful implementation of Supabase authentication in @knowcode/doc-builder v1.7.5+."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Completed</a>
|
|
232
|
-
<a href="/private/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Implementation Plan</a>
|
|
233
|
-
<a href="/private/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Integration Plan</a>
|
|
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="ph ph-check-circle" style="color: #059669;"></i> Supabase Auth Setup Guide</a>
|
|
235
|
-
<a href="/private/test-private-doc.html" class="nav-item" data-tooltip="Test Private Document."><i class="ph ph-file-text"></i> Test Private Doc</a>
|
|
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="ph ph-check-circle" style="color: #059669;"></i> User Management Tooling</a></div></div>
|
|
237
|
-
<div class="nav-section private-nav" data-level="2">
|
|
238
|
-
<a class="nav-title collapsible expanded" href="/private/launch/README.html" data-target="nav-private-launch-2" >
|
|
239
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-rocket-launch"></i> Launch
|
|
240
|
-
</a>
|
|
241
|
-
<div class="nav-content" id="nav-private-launch-2">
|
|
242
|
-
<a href="/private/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="ph ph-check-circle" style="color: #059669;"></i> Launch Overview</a>
|
|
243
|
-
<a href="/private/launch/auth-cleanup-summary.html" class="nav-item" data-tooltip="All references to the old client-side authentication system have been removed from @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> Auth Cleanup Summary</a>
|
|
244
|
-
<a href="/private/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Bubble Plugin Specification</a>
|
|
245
|
-
<a href="/private/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Go To Market Strategy</a>
|
|
246
|
-
<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="ph ph-check-circle" style="color: #059669;"></i> Launch Announcements</a>
|
|
247
|
-
<a href="/private/launch/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Vercel Deployment Auth Setup</a></div></div>
|
|
248
|
-
<div class="nav-section" data-level="1">
|
|
249
|
-
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
250
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
251
|
-
</a>
|
|
252
|
-
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
253
|
-
<a href="/prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #059669;"></i> Beautiful Documentation Design</a>
|
|
254
|
-
<a href="/prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
|
|
255
|
-
<a href="/prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to "sasha-publish", including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
|
|
256
|
-
<div class="nav-section" data-level="1">
|
|
257
|
-
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
258
|
-
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
259
|
-
</a>
|
|
260
|
-
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
261
|
-
<a href="/test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
|
|
262
|
-
<a href="/test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
|
|
263
|
-
<a href="/test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
|
|
264
|
-
</nav>
|
|
265
|
-
<div class="resize-handle"></div>
|
|
266
|
-
</aside>
|
|
267
|
-
|
|
268
|
-
<!-- Content Area -->
|
|
269
|
-
<main class="content">
|
|
270
|
-
<div class="content-inner">
|
|
271
|
-
<h1>Launch Announcement Templates</h1>
|
|
272
|
-
<h2>Overview</h2>
|
|
273
|
-
<p>This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels.</p>
|
|
274
|
-
<h2>Product Hunt Launch</h2>
|
|
275
|
-
<h3>Title</h3>
|
|
276
|
-
<p><strong>Doc Builder - Transform markdown into beautiful documentation sites</strong></p>
|
|
277
|
-
<h3>Tagline</h3>
|
|
278
|
-
<p>Notion-inspired documentation generator with one-command Vercel deployment</p>
|
|
279
|
-
<h3>Description</h3>
|
|
280
|
-
<p>Hey Product Hunt! 👋</p>
|
|
281
|
-
<p>I'm excited to share Doc Builder, a tool I built to solve my own documentation frustrations.</p>
|
|
282
|
-
<p><strong>The Problem:</strong><br>Every time I needed to create documentation for a project, I faced the same issues:</p>
|
|
283
|
-
<ul>
|
|
284
|
-
<li>Setting up a documentation framework took hours</li>
|
|
285
|
-
<li>Most solutions were either too complex or too basic</li>
|
|
286
|
-
<li>Deployment was always a separate headache</li>
|
|
287
|
-
<li>The output rarely looked professional</li>
|
|
288
|
-
</ul>
|
|
289
|
-
<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>
|
|
290
|
-
<p><strong>Key Features:</strong><br><i style="font-size: 1.2em" class="ph ph-sparkle" aria-label="special"></i> <strong>Notion-inspired design</strong> - Clean, modern UI that readers love<br><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> <strong>One-command deployment</strong> - <code>npx @knowcode/doc-builder@latest deploy</code><br><i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> <strong>Full-text search</strong> - Find anything instantly<br><i style="font-size: 1.2em" class="ph ph-moon-stars" aria-label="half moon"></i> <strong>Dark mode</strong> - Easy on the eyes<br><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> <strong>Mermaid diagrams</strong> - Visualize complex concepts<br><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> <strong>Password protection</strong> - Keep internal docs secure<br><i style="font-size: 1.2em" class="ph ph-device-mobile" aria-label="mobile"></i> <strong>Fully responsive</strong> - Perfect on any device</p>
|
|
291
|
-
<p><strong>Perfect for:</strong></p>
|
|
292
|
-
<ul>
|
|
293
|
-
<li>Open source projects</li>
|
|
294
|
-
<li>API documentation</li>
|
|
295
|
-
<li>Team knowledge bases</li>
|
|
296
|
-
<li>Technical guides</li>
|
|
297
|
-
<li>Product documentation</li>
|
|
298
|
-
</ul>
|
|
299
|
-
<p><strong>Try it now:</strong></p>
|
|
300
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest init
|
|
301
|
-
npx @knowcode/doc-builder@latest deploy
|
|
302
|
-
</code></pre>
|
|
303
|
-
<p>Live demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></p>
|
|
304
|
-
<p>Would love to hear your feedback and answer any questions!</p>
|
|
305
|
-
<h3>Gallery Images</h3>
|
|
306
|
-
<ol>
|
|
307
|
-
<li>Homepage screenshot showing Notion-inspired design</li>
|
|
308
|
-
<li>Dark mode example</li>
|
|
309
|
-
<li>Search functionality demo</li>
|
|
310
|
-
<li>Mermaid diagram example</li>
|
|
311
|
-
<li>Mobile responsive view</li>
|
|
312
|
-
</ol>
|
|
313
|
-
<h2>Hacker News Post</h2>
|
|
314
|
-
<h3>Title</h3>
|
|
315
|
-
<p>Show HN: I built a documentation generator that deploys to Vercel in one command</p>
|
|
316
|
-
<h3>Post</h3>
|
|
317
|
-
<p>I got tired of the complexity involved in creating good-looking documentation sites, so I built Doc Builder.</p>
|
|
318
|
-
<p>It's a simple tool that:</p>
|
|
319
|
-
<ul>
|
|
320
|
-
<li>Converts markdown to beautiful HTML (Notion-inspired design)</li>
|
|
321
|
-
<li>Deploys to Vercel with zero configuration</li>
|
|
322
|
-
<li>Includes search, dark mode, and syntax highlighting out of the box</li>
|
|
323
|
-
<li>Supports Mermaid diagrams for visualizations</li>
|
|
324
|
-
</ul>
|
|
325
|
-
<p>The entire flow is just:</p>
|
|
326
|
-
<pre><code>npx @knowcode/doc-builder@latest init
|
|
327
|
-
npx @knowcode/doc-builder@latest deploy
|
|
328
|
-
</code></pre>
|
|
329
|
-
<p>I've been using it for all my projects and it's saved me hours of setup time. The output looks professional without any CSS tweaking.</p>
|
|
330
|
-
<p>Technical details:</p>
|
|
331
|
-
<ul>
|
|
332
|
-
<li>Built with Node.js</li>
|
|
333
|
-
<li>Generates static HTML for performance</li>
|
|
334
|
-
<li>SEO optimized with meta tags and structured data</li>
|
|
335
|
-
<li>Optional password protection for private docs</li>
|
|
336
|
-
<li>Automatic navigation generation from folder structure</li>
|
|
337
|
-
</ul>
|
|
338
|
-
<p>Demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a><br>NPM: <a href="https://www.npmjs.com/package/@knowcode/doc-builder">https://www.npmjs.com/package/@knowcode/doc-builder</a></p>
|
|
339
|
-
<p>The code is MIT licensed. Would love feedback from the HN community!</p>
|
|
340
|
-
<h2>Twitter/X Thread</h2>
|
|
341
|
-
<h3>Thread</h3>
|
|
342
|
-
<p>🧵 1/7<br>Just launched Doc Builder - a tool that transforms your markdown into beautiful documentation sites with ONE command <i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i></p>
|
|
343
|
-
<p>No more hours of setup. No more ugly docs.</p>
|
|
344
|
-
<p>npx @knowcode/doc-builder@latest deploy</p>
|
|
345
|
-
<p>That's it. You're live on Vercel.</p>
|
|
346
|
-
<p>2/7<br>The problem: Every documentation tool is either:</p>
|
|
347
|
-
<ul>
|
|
348
|
-
<li>Too complex (hours to configure)</li>
|
|
349
|
-
<li>Too simple (looks unprofessional)</li>
|
|
350
|
-
<li>Requires separate deployment setup</li>
|
|
351
|
-
<li>Costs too much for small projects</li>
|
|
352
|
-
</ul>
|
|
353
|
-
<p>I needed something better.</p>
|
|
354
|
-
<p>3/7<br>Doc Builder features:<br><i style="font-size: 1.2em" class="ph ph-sparkle" aria-label="special"></i> Notion-inspired design<br><i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> Full-text search built-in<br><i style="font-size: 1.2em" class="ph ph-moon-stars" aria-label="half moon"></i> Automatic dark mode<br><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Mermaid diagram support<br><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Optional password protection<br><i style="font-size: 1.2em" class="ph ph-device-mobile" aria-label="mobile"></i> Mobile responsive<br><i style="font-size: 1.2em" class="ph ph-lightning" aria-label="fast"></i> Lightning fast (static HTML)</p>
|
|
355
|
-
<p>4/7<br>Perfect for:</p>
|
|
356
|
-
<ul>
|
|
357
|
-
<li>Open source projects</li>
|
|
358
|
-
<li>API documentation </li>
|
|
359
|
-
<li>Team wikis</li>
|
|
360
|
-
<li>Technical guides</li>
|
|
361
|
-
<li>Personal knowledge bases</li>
|
|
362
|
-
</ul>
|
|
363
|
-
<p>Zero configuration needed. It just works.</p>
|
|
364
|
-
<p>5/7<br>The magic is in the simplicity:</p>
|
|
365
|
-
<ol>
|
|
366
|
-
<li>Write markdown files</li>
|
|
367
|
-
<li>Run: npx @knowcode/doc-builder@latest init</li>
|
|
368
|
-
<li>Run: npx @knowcode/doc-builder@latest deploy</li>
|
|
369
|
-
<li>Your docs are live!</li>
|
|
370
|
-
</ol>
|
|
371
|
-
<p>No build configs. No deployment scripts. No hassle.</p>
|
|
372
|
-
<p>6/7<br>Built this because I was tired of spending more time setting up docs than writing them.</p>
|
|
373
|
-
<p>Now I can focus on content, not configuration.</p>
|
|
374
|
-
<p>Check out the demo: doc-builder-delta.vercel.app</p>
|
|
375
|
-
<p>7/7<br>It's open source (MIT license) and available on npm today!</p>
|
|
376
|
-
<p>Would love your feedback. What features would make this even better for your documentation needs?</p>
|
|
377
|
-
<p>Try it: npmjs.com/package/@knowcode/doc-builder</p>
|
|
378
|
-
<p>#buildinpublic #documentation #webdev #opensource</p>
|
|
379
|
-
<h2>LinkedIn Post</h2>
|
|
380
|
-
<h3>Post</h3>
|
|
381
|
-
<p><i style="font-size: 1.2em" class="ph ph-confetti" aria-label="party"></i> Excited to announce the launch of Doc Builder - a developer tool that transforms markdown documentation into beautiful, searchable websites with just one command.</p>
|
|
382
|
-
<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>
|
|
383
|
-
<p><strong>The Solution:</strong><br>Doc Builder eliminates this complexity. With a single command, you can deploy professional-looking documentation to Vercel:</p>
|
|
384
|
-
<p><code>npx @knowcode/doc-builder@latest deploy</code></p>
|
|
385
|
-
<p><strong>Key Benefits:</strong><br>• <i style="font-size: 1.2em" class="ph ph-timer" aria-label="timer"></i> Save hours of setup time<br>• <i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> Professional Notion-inspired design out of the box<br>• <i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> Built-in search functionality<br>• <i style="font-size: 1.2em" class="ph ph-moon-stars" aria-label="half moon"></i> Automatic dark mode support<br>• <i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Mermaid diagram integration<br>• <i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Optional password protection<br>• <i style="font-size: 1.2em" class="ph ph-device-mobile" aria-label="mobile"></i> Fully responsive design</p>
|
|
386
|
-
<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>
|
|
387
|
-
<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>
|
|
388
|
-
<p>Try the live demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></p>
|
|
389
|
-
<p>I'd love to connect with others passionate about developer tools and documentation. What's your biggest pain point when creating technical documentation?</p>
|
|
390
|
-
<p>#DeveloperTools #TechnicalDocumentation #OpenSource #WebDevelopment #ProductLaunch</p>
|
|
391
|
-
<h2>Dev.to Article</h2>
|
|
392
|
-
<h3>Title</h3>
|
|
393
|
-
<p>I Built a Documentation Generator That Deploys in One Command - Here's Why and How</p>
|
|
394
|
-
<h3>Tags</h3>
|
|
395
|
-
<p><code>webdev</code>, <code>javascript</code>, <code>opensource</code>, <code>productivity</code></p>
|
|
396
|
-
<h3>Content</h3>
|
|
397
|
-
<h2>The Problem That Started It All</h2>
|
|
398
|
-
<p>Last month, I was starting my fifth project of the year, and once again, I found myself spending hours setting up documentation infrastructure. Configure this, install that, write deployment scripts, fix CSS issues... </p>
|
|
399
|
-
<p>Sound familiar?</p>
|
|
400
|
-
<p>That's when I decided enough was enough. I needed a documentation tool that:</p>
|
|
401
|
-
<ul>
|
|
402
|
-
<li>Works out of the box</li>
|
|
403
|
-
<li>Looks professional without customization</li>
|
|
404
|
-
<li>Deploys with zero configuration</li>
|
|
405
|
-
<li>Doesn't require a PhD in DevOps</li>
|
|
406
|
-
</ul>
|
|
407
|
-
<h2>Enter Doc Builder</h2>
|
|
408
|
-
<p>Doc Builder is a simple tool that transforms your markdown files into beautiful, searchable documentation sites. The entire setup and deployment process takes less than a minute.</p>
|
|
409
|
-
<h3>How It Works</h3>
|
|
410
|
-
<ol>
|
|
411
|
-
<li><strong>Install and Initialize</strong></li>
|
|
412
|
-
</ol>
|
|
413
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest init
|
|
414
|
-
</code></pre>
|
|
415
|
-
<p>This creates a simple structure:</p>
|
|
416
|
-
<pre><code>your-project/
|
|
417
|
-
├── docs/
|
|
418
|
-
│ └── README.md
|
|
419
|
-
└── doc-builder.config.js
|
|
420
|
-
</code></pre>
|
|
421
|
-
<ol start="2">
|
|
422
|
-
<li><strong>Write Your Docs</strong><br>Just create markdown files in the <code>docs</code> folder. Doc Builder automatically:</li>
|
|
423
|
-
</ol>
|
|
424
|
-
<ul>
|
|
425
|
-
<li>Generates navigation from your folder structure</li>
|
|
426
|
-
<li>Extracts titles and summaries for tooltips</li>
|
|
427
|
-
<li>Creates a searchable index</li>
|
|
428
|
-
<li>Applies Notion-inspired styling</li>
|
|
429
|
-
</ul>
|
|
430
|
-
<ol start="3">
|
|
431
|
-
<li><strong>Deploy to Production</strong></li>
|
|
432
|
-
</ol>
|
|
433
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
434
|
-
</code></pre>
|
|
435
|
-
<p>That's it! Your documentation is now live on Vercel with a public URL.</p>
|
|
436
|
-
<h2>Key Features That Make It Special</h2>
|
|
437
|
-
<h3><i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> Beautiful by Default</h3>
|
|
438
|
-
<p>I spent weeks perfecting the design so you don't have to. The Notion-inspired interface is clean, modern, and professional.</p>
|
|
439
|
-
<h3><i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> Search That Actually Works</h3>
|
|
440
|
-
<p>Full-text search is built-in. No configuration needed. It just works.</p>
|
|
441
|
-
<h3><i style="font-size: 1.2em" class="ph ph-moon-stars" aria-label="half moon"></i> Dark Mode</h3>
|
|
442
|
-
<p>Automatic theme detection with manual toggle. Your readers' eyes will thank you.</p>
|
|
443
|
-
<h3><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Mermaid Diagrams</h3>
|
|
444
|
-
<div class="mermaid-wrapper">
|
|
445
|
-
<div class="mermaid">graph TD
|
|
446
|
-
A[Write Markdown] --> B[Run Deploy]
|
|
447
|
-
B --> C[Live Documentation]</div>
|
|
448
|
-
</div>
|
|
449
|
-
<h3><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Password Protection</h3>
|
|
450
|
-
<p>Need private docs? Enable authentication with one config line:</p>
|
|
451
|
-
<pre><code class="language-javascript">features: {
|
|
452
|
-
authentication: true
|
|
453
|
-
}
|
|
454
|
-
</code></pre>
|
|
455
|
-
<h2>The Technical Details</h2>
|
|
456
|
-
<p>For the curious developers, here's what's under the hood:</p>
|
|
457
|
-
<ul>
|
|
458
|
-
<li><strong>Static Site Generation</strong>: Pure HTML/CSS/JS for maximum performance</li>
|
|
459
|
-
<li><strong>Zero Dependencies</strong>: No runtime framework needed</li>
|
|
460
|
-
<li><strong>SEO Optimized</strong>: Meta tags, structured data, sitemap generation</li>
|
|
461
|
-
<li><strong>Responsive Design</strong>: Mobile-first approach</li>
|
|
462
|
-
<li><strong>Incremental Builds</strong>: Only rebuilds changed files</li>
|
|
463
|
-
</ul>
|
|
464
|
-
<h2>Real-World Usage</h2>
|
|
465
|
-
<p>I've been dogfooding Doc Builder for all my projects:</p>
|
|
466
|
-
<ul>
|
|
467
|
-
<li>API documentation with code examples</li>
|
|
468
|
-
<li>Internal team wikis</li>
|
|
469
|
-
<li>Open source project docs</li>
|
|
470
|
-
<li>Personal knowledge base</li>
|
|
471
|
-
</ul>
|
|
472
|
-
<p>The feedback has been overwhelmingly positive. Developers love the simplicity and designers love the aesthetics.</p>
|
|
473
|
-
<h2>What's Next?</h2>
|
|
474
|
-
<p>I'm working on:</p>
|
|
475
|
-
<ul>
|
|
476
|
-
<li>GitHub Action for automated deployments</li>
|
|
477
|
-
<li>More themes (though many users love the current one)</li>
|
|
478
|
-
<li>Plugin system for extensions</li>
|
|
479
|
-
<li>Internationalization support</li>
|
|
480
|
-
</ul>
|
|
481
|
-
<h2>Try It Yourself</h2>
|
|
482
|
-
<pre><code class="language-bash"># Create a test project
|
|
483
|
-
mkdir my-docs && cd my-docs
|
|
484
|
-
|
|
485
|
-
# Initialize
|
|
486
|
-
npx @knowcode/doc-builder@latest init
|
|
487
|
-
|
|
488
|
-
# Start local server
|
|
489
|
-
npx @knowcode/doc-builder@latest dev
|
|
490
|
-
|
|
491
|
-
# Deploy when ready
|
|
492
|
-
npx @knowcode/doc-builder@latest deploy
|
|
493
|
-
</code></pre>
|
|
494
|
-
<h2>Conclusion</h2>
|
|
495
|
-
<p>Doc Builder is my answer to documentation complexity. It's open source, MIT licensed, and available on npm today.</p>
|
|
496
|
-
<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>
|
|
497
|
-
<p><strong>Links:</strong></p>
|
|
498
|
-
<ul>
|
|
499
|
-
<li><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> <a href="https://doc-builder-delta.vercel.app">Live Demo</a></li>
|
|
500
|
-
<li><i style="font-size: 1.2em" class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
501
|
-
<li><i style="font-size: 1.2em" class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/knowcode/doc-builder">GitHub Repo</a> (coming soon)</li>
|
|
502
|
-
</ul>
|
|
503
|
-
<p>What's your biggest documentation pain point? Let me know in the comments!</p>
|
|
504
|
-
<h2>Reddit Posts</h2>
|
|
505
|
-
<h3>r/webdev</h3>
|
|
506
|
-
<p><strong>Title:</strong> I made a documentation generator that deploys to Vercel in literally one command</p>
|
|
507
|
-
<p><strong>Post:</strong><br>Hey r/webdev!</p>
|
|
508
|
-
<p>Just launched my latest project - Doc Builder. It's a tool that converts markdown to beautiful documentation sites and deploys them with a single command.</p>
|
|
509
|
-
<p><strong>Why I built it:</strong><br>I was tired of spending hours setting up documentation for every new project. Existing solutions were either too complex or produced ugly output.</p>
|
|
510
|
-
<p><strong>What it does:</strong></p>
|
|
511
|
-
<ul>
|
|
512
|
-
<li>Converts markdown → beautiful HTML (Notion-inspired design)</li>
|
|
513
|
-
<li>One command deployment: <code>npx @knowcode/doc-builder@latest deploy</code></li>
|
|
514
|
-
<li>Includes search, dark mode, syntax highlighting</li>
|
|
515
|
-
<li>Zero configuration needed</li>
|
|
516
|
-
</ul>
|
|
517
|
-
<p><strong>Cool features:</strong></p>
|
|
518
|
-
<ul>
|
|
519
|
-
<li>Mermaid diagram support</li>
|
|
520
|
-
<li>Password protection option</li>
|
|
521
|
-
<li>Auto-generated navigation</li>
|
|
522
|
-
<li>SEO optimized</li>
|
|
523
|
-
<li>Fully responsive</li>
|
|
524
|
-
</ul>
|
|
525
|
-
<p><strong>Tech stack:</strong></p>
|
|
526
|
-
<ul>
|
|
527
|
-
<li>Node.js</li>
|
|
528
|
-
<li>Static HTML generation</li>
|
|
529
|
-
<li>Vanilla JS (no framework dependencies)</li>
|
|
530
|
-
</ul>
|
|
531
|
-
<p>Demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></p>
|
|
532
|
-
<p>It's open source and on npm. Would love feedback from fellow developers!</p>
|
|
533
|
-
<h3>r/javascript</h3>
|
|
534
|
-
<p><strong>Title:</strong> [Showoff Saturday] Built a zero-config documentation generator in Node.js</p>
|
|
535
|
-
<p><strong>Post:</strong><br>For this Showoff Saturday, I want to share Doc Builder - a Node.js tool I built to solve my documentation woes.</p>
|
|
536
|
-
<p><strong>The problem:</strong> Every documentation tool required tons of configuration and the output looked dated.</p>
|
|
537
|
-
<p><strong>My solution:</strong> A tool that works out of the box with beautiful, modern output.</p>
|
|
538
|
-
<p><strong>Technical highlights:</strong></p>
|
|
539
|
-
<ul>
|
|
540
|
-
<li>Pure Node.js implementation</li>
|
|
541
|
-
<li>Generates static HTML for performance</li>
|
|
542
|
-
<li>No runtime dependencies</li>
|
|
543
|
-
<li>Automatic code syntax highlighting</li>
|
|
544
|
-
<li>Built-in search using lunr.js</li>
|
|
545
|
-
<li>Mermaid integration for diagrams</li>
|
|
546
|
-
</ul>
|
|
547
|
-
<p><strong>Usage:</strong></p>
|
|
548
|
-
<pre><code class="language-javascript">// Programmatic API
|
|
549
|
-
const { build } = require('@knowcode/doc-builder');
|
|
550
|
-
|
|
551
|
-
await build({
|
|
552
|
-
siteName: 'My Docs',
|
|
553
|
-
docsDir: './docs',
|
|
554
|
-
outputDir: './dist'
|
|
555
|
-
});
|
|
556
|
-
</code></pre>
|
|
557
|
-
<p>Or via CLI:</p>
|
|
558
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
559
|
-
</code></pre>
|
|
560
|
-
<p>NPM: <a href="https://www.npmjs.com/package/@knowcode/doc-builder">https://www.npmjs.com/package/@knowcode/doc-builder</a></p>
|
|
561
|
-
<p>Learned a lot building this, happy to answer technical questions!</p>
|
|
562
|
-
<h2>Email Newsletter</h2>
|
|
563
|
-
<h3>Subject</h3>
|
|
564
|
-
<p><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Introducing Doc Builder: Beautiful Documentation in One Command</p>
|
|
565
|
-
<h3>Body</h3>
|
|
566
|
-
<p>Hi {firstName},</p>
|
|
567
|
-
<p>Remember the last time you spent hours setting up documentation for a project?</p>
|
|
568
|
-
<p>The configuring, the styling, the deployment scripts... What if I told you all of that could be replaced with a single command?</p>
|
|
569
|
-
<p><strong>Introducing Doc Builder</strong></p>
|
|
570
|
-
<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>
|
|
571
|
-
<p><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Converts your markdown to beautiful, searchable websites<br><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Deploys to Vercel with zero configuration<br><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Looks professional out of the box (Notion-inspired design)<br><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> Includes dark mode, search, and syntax highlighting</p>
|
|
572
|
-
<p><strong>See It In Action</strong></p>
|
|
573
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
574
|
-
</code></pre>
|
|
575
|
-
<p>That's it. Your documentation is live.</p>
|
|
576
|
-
<p><strong>Perfect For:</strong></p>
|
|
577
|
-
<ul>
|
|
578
|
-
<li>Open source projects</li>
|
|
579
|
-
<li>API documentation</li>
|
|
580
|
-
<li>Team knowledge bases</li>
|
|
581
|
-
<li>Technical guides</li>
|
|
582
|
-
<li>Personal wikis</li>
|
|
583
|
-
</ul>
|
|
584
|
-
<p><strong>What Early Users Are Saying:</strong></p>
|
|
585
|
-
<p><em>"Finally, a documentation tool that just works. No more wrestling with configs!"</em> - Sarah D., Frontend Developer</p>
|
|
586
|
-
<p><em>"The design is beautiful. Our docs have never looked this good."</em> - Mike R., Team Lead</p>
|
|
587
|
-
<p><em>"Saved us literally days of setup time across our projects."</em> - Jennifer K., CTO</p>
|
|
588
|
-
<p><strong>Try It Today</strong></p>
|
|
589
|
-
<p>Check out the live demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></p>
|
|
590
|
-
<p>Or jump right in:</p>
|
|
591
|
-
<pre><code class="language-bash">npm install -g @knowcode/doc-builder
|
|
592
|
-
doc-builder init
|
|
593
|
-
doc-builder deploy
|
|
594
|
-
</code></pre>
|
|
595
|
-
<p><strong>Special Launch Offer</strong></p>
|
|
596
|
-
<p>For the next 48 hours, I'm offering 50% off the Pro plan for early adopters. Use code LAUNCH50 when upgrading.</p>
|
|
597
|
-
<p>Questions? Just reply to this email. I personally read every message.</p>
|
|
598
|
-
<p>Happy documenting!</p>
|
|
599
|
-
<p>Best,<br>Lindsay Smith<br>Creator of Doc Builder</p>
|
|
600
|
-
<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! <i style="font-size: 1.2em" class="ph ph-star-four" aria-label="sparkle"></i></p>
|
|
601
|
-
<hr>
|
|
602
|
-
<h2>Press Release</h2>
|
|
603
|
-
<h3>FOR IMMEDIATE RELEASE</h3>
|
|
604
|
-
<p><strong>KnowCode Launches Doc Builder: A Revolutionary Documentation Tool That Deploys in One Command</strong></p>
|
|
605
|
-
<p><em>New open-source tool transforms how developers create and deploy technical documentation</em></p>
|
|
606
|
-
<p><strong>London, UK - July 22, 2025</strong> - KnowCode Ltd today announced the public release of Doc Builder, an innovative documentation generator that dramatically simplifies the process of creating and deploying professional technical documentation.</p>
|
|
607
|
-
<p>Doc Builder addresses a long-standing pain point in software development: the complexity and time investment required to set up documentation infrastructure. With Doc Builder, developers can transform markdown files into beautiful, searchable documentation websites and deploy them to Vercel with a single command.</p>
|
|
608
|
-
<p>"We've eliminated hours of setup time," said Lindsay Smith, Creator of Doc Builder. "Developers can now focus on writing great documentation instead of configuring build tools and deployment pipelines."</p>
|
|
609
|
-
<p><strong>Key features include:</strong></p>
|
|
610
|
-
<ul>
|
|
611
|
-
<li>One-command deployment to Vercel</li>
|
|
612
|
-
<li>Notion-inspired design that requires no customization</li>
|
|
613
|
-
<li>Built-in full-text search functionality</li>
|
|
614
|
-
<li>Automatic dark mode support</li>
|
|
615
|
-
<li>Mermaid diagram integration</li>
|
|
616
|
-
<li>Optional password protection for private documentation</li>
|
|
617
|
-
<li>Mobile-responsive design</li>
|
|
618
|
-
</ul>
|
|
619
|
-
<p>The tool has already gained traction in the developer community, with 21 releases published to npm and active adoption across various open-source projects.</p>
|
|
620
|
-
<p>"Doc Builder represents our commitment to creating developer tools that are both powerful and simple to use," added Smith. "We believe great documentation shouldn't require a complex setup process."</p>
|
|
621
|
-
<p>Doc Builder is available immediately as an open-source project under the MIT license. Developers can try it instantly using npx or install it via npm.</p>
|
|
622
|
-
<p><strong>About KnowCode Ltd</strong><br>KnowCode is a software company focused on creating innovative developer tools that simplify complex workflows. Founded in 2023, the company is committed to open-source development and community-driven innovation.</p>
|
|
623
|
-
<p><strong>Contact:</strong><br>Lindsay Smith<br><a href="mailto:support@knowcode.tech">support@knowcode.tech</a><br><a href="https://knowcode.tech">https://knowcode.tech</a></p>
|
|
624
|
-
<p><strong>Resources:</strong></p>
|
|
625
|
-
<ul>
|
|
626
|
-
<li>Live Demo: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></li>
|
|
627
|
-
<li>NPM Package: <a href="https://www.npmjs.com/package/@knowcode/doc-builder">https://www.npmjs.com/package/@knowcode/doc-builder</a></li>
|
|
628
|
-
<li>Documentation: <a href="https://doc-builder-delta.vercel.app">https://doc-builder-delta.vercel.app</a></li>
|
|
629
|
-
</ul>
|
|
630
|
-
<h3></h3>
|
|
631
|
-
<hr>
|
|
632
|
-
<h2>Document History</h2>
|
|
633
|
-
<table>
|
|
634
|
-
<thead>
|
|
635
|
-
<tr>
|
|
636
|
-
<th>Date</th>
|
|
637
|
-
<th>Author</th>
|
|
638
|
-
<th>Changes</th>
|
|
639
|
-
</tr>
|
|
640
|
-
</thead>
|
|
641
|
-
<tbody><tr>
|
|
642
|
-
<td>2025-07-22</td>
|
|
643
|
-
<td>System</td>
|
|
644
|
-
<td>Initial announcement templates</td>
|
|
645
|
-
</tr>
|
|
646
|
-
</tbody></table>
|
|
647
|
-
|
|
648
|
-
</div>
|
|
649
|
-
</main>
|
|
650
|
-
</div>
|
|
651
|
-
|
|
652
|
-
<!-- Scripts -->
|
|
653
|
-
<script>
|
|
654
|
-
// Pass configuration to frontend
|
|
655
|
-
window.docBuilderConfig = {
|
|
656
|
-
features: {
|
|
657
|
-
showPdfDownload: true,
|
|
658
|
-
menuDefaultOpen: false,
|
|
659
|
-
mermaidEnhanced: true
|
|
660
|
-
}
|
|
661
|
-
};
|
|
662
|
-
</script>
|
|
663
|
-
<script src="/js/main.js"></script>
|
|
664
|
-
<script src="https://unpkg.com/@supabase/supabase-js@2"></script>
|
|
665
|
-
<script src="/js/auth.js"></script>
|
|
666
|
-
</body>
|
|
667
|
-
</html>
|