@knowcode/doc-builder 1.9.20 → 1.9.21
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/cli.js +15 -1
- package/doc-builder.config.js +4 -2
- package/doc-builder.config.js.backup.1754567425847 +124 -0
- package/html/README.html +3 -3
- package/html/about-doc-builder.html +3 -3
- package/html/documentation-index.html +3 -3
- package/html/guides/authentication-default-change.html +3 -3
- package/html/guides/authentication-guide.html +3 -3
- package/html/guides/claude-workflow-guide.html +3 -3
- package/html/guides/configuration-guide.html +3 -3
- package/html/guides/documentation-standards.html +3 -3
- package/html/guides/html-embedding-guide.html +3 -3
- package/html/guides/image-modal-guide.html +3 -3
- package/html/guides/phosphor-icons-guide.html +3 -3
- package/html/guides/private-directory-authentication-troubleshooting.html +3 -3
- package/html/guides/private-directory-authentication.html +3 -3
- package/html/guides/public-site-deployment.html +3 -3
- package/html/guides/search-engine-verification-guide.html +3 -3
- package/html/guides/seo-guide.html +3 -3
- package/html/guides/seo-optimization-guide.html +3 -3
- package/html/guides/supabase-authentication-complete-guide.html +3 -3
- package/html/guides/troubleshooting-guide.html +3 -3
- package/html/guides/windows-setup-guide.html +3 -3
- package/html/image-modal-test.html +3 -3
- package/html/index.html +3 -3
- package/html/private/cache-control-anti-pattern.html +3 -3
- package/html/private/launch/README.html +3 -3
- package/html/private/launch/auth-cleanup-summary.html +3 -3
- package/html/private/launch/bubble-plugin-specification.html +3 -3
- package/html/private/launch/go-to-market-strategy.html +3 -3
- package/html/private/launch/launch-announcements.html +3 -3
- package/html/private/launch/vercel-deployment-auth-setup.html +3 -3
- package/html/private/next-steps-walkthrough.html +3 -3
- package/html/private/supabase-auth-implementation-completed.html +3 -3
- package/html/private/supabase-auth-implementation-plan.html +3 -3
- package/html/private/supabase-auth-integration-plan.html +3 -3
- package/html/private/supabase-auth-setup-guide.html +3 -3
- package/html/private/test-private-doc.html +3 -3
- package/html/private/user-management-tooling.html +3 -3
- package/html/prompts/beautiful-documentation-design.html +3 -3
- package/html/prompts/markdown-document-standards.html +3 -3
- package/html/prompts/project-rename-strategy-sasha-publish.html +3 -3
- package/html/sitemap.xml +59 -59
- package/html/test-questions/how-does-it-work%3F.html +3 -3
- package/html/test-questions/step-1%3A%20getting-started.html +3 -3
- package/html/test-questions/what-is-the-purpose.html +3 -3
- package/html/vercel-cli-setup-guide.html +3 -3
- package/html/vercel-first-time-setup-guide.html +3 -3
- package/html-static/404.html +115 -0
- package/html-static/README.html +456 -0
- package/html-static/about-doc-builder.html +425 -0
- package/html-static/css/notion-style.css +2426 -0
- package/html-static/documentation-index.html +405 -0
- package/html-static/guides/authentication-default-change.html +304 -0
- package/html-static/guides/authentication-guide.html +443 -0
- package/html-static/guides/claude-workflow-guide.html +1008 -0
- package/html-static/guides/configuration-guide.html +406 -0
- package/html-static/guides/documentation-standards.html +628 -0
- package/html-static/guides/html-embedding-guide.html +395 -0
- package/html-static/guides/image-modal-guide.html +449 -0
- package/html-static/guides/phosphor-icons-guide.html +518 -0
- package/html-static/guides/private-directory-authentication-troubleshooting.html +489 -0
- package/html-static/guides/private-directory-authentication.html +475 -0
- package/html-static/guides/public-site-deployment.html +365 -0
- package/html-static/guides/search-engine-verification-guide.html +476 -0
- package/html-static/guides/seo-guide.html +595 -0
- package/html-static/guides/seo-optimization-guide.html +821 -0
- package/html-static/guides/supabase-authentication-complete-guide.html +800 -0
- package/html-static/guides/troubleshooting-guide.html +567 -0
- package/html-static/guides/windows-setup-guide.html +793 -0
- package/html-static/image-modal-test.html +252 -0
- package/html-static/index.html +456 -0
- package/html-static/js/main.js +1692 -0
- package/html-static/prompts/beautiful-documentation-design.html +718 -0
- package/html-static/prompts/markdown-document-standards.html +356 -0
- package/html-static/prompts/project-rename-strategy-sasha-publish.html +464 -0
- package/html-static/robots.txt +5 -0
- package/html-static/sitemap.xml +189 -0
- package/html-static/test-questions/how-does-it-work%3F.html +228 -0
- package/html-static/test-questions/step-1%3A%20getting-started.html +223 -0
- package/html-static/test-questions/what-is-the-purpose.html +227 -0
- package/html-static/vercel-cli-setup-guide.html +429 -0
- package/html-static/vercel-first-time-setup-guide.html +388 -0
- package/lib/config.js +9 -2
- package/lib/core-builder.js +148 -4
- package/package.json +1 -1
|
@@ -0,0 +1,425 @@
|
|
|
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 documentation site was built with @knowcode/doc-builder - a zero-configuration documentation generator that transforms markdown files into beautiful...">
|
|
7
|
+
<title>About @knowcode/doc-builder | @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, knowcode, doc">
|
|
12
|
+
<meta name="robots" content="index, follow">
|
|
13
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/about-doc-builder.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/about-doc-builder.html">
|
|
18
|
+
<meta property="og:title" content="About @knowcode/doc-builder | @knowcode/doc-builder">
|
|
19
|
+
<meta property="og:description" content="This documentation site was built with @knowcode/doc-builder - a zero-configuration documentation generator that transforms markdown files into beautiful...">
|
|
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="About @knowcode/doc-builder | @knowcode/doc-builder">
|
|
29
|
+
<meta name="twitter:description" content="This documentation site was built with @knowcode/doc-builder - a zero-configuration documentation generator that transforms markdown files into beautiful...">
|
|
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
|
+
<!-- Favicon -->
|
|
52
|
+
<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>">
|
|
53
|
+
|
|
54
|
+
<script type="application/ld+json">
|
|
55
|
+
{
|
|
56
|
+
"@context": "https://schema.org",
|
|
57
|
+
"@type": "TechArticle",
|
|
58
|
+
"headline": "About @knowcode/doc-builder",
|
|
59
|
+
"description": "This documentation site was built with @knowcode/doc-builder - a zero-configuration documentation generator that transforms markdown files into beautiful...",
|
|
60
|
+
"author": {
|
|
61
|
+
"@type": "Person",
|
|
62
|
+
"name": "Lindsay Smith"
|
|
63
|
+
},
|
|
64
|
+
"publisher": {
|
|
65
|
+
"@type": "Organization",
|
|
66
|
+
"name": "Knowcode Ltd",
|
|
67
|
+
"url": "https://knowcode.tech"
|
|
68
|
+
},
|
|
69
|
+
"datePublished": "2025-08-07T11:50:26.060Z",
|
|
70
|
+
"dateModified": "2025-08-07T11:50:26.060Z",
|
|
71
|
+
"mainEntityOfPage": {
|
|
72
|
+
"@type": "WebPage",
|
|
73
|
+
"@id": "https://doc-builder-delta.vercel.app/about-doc-builder.html"
|
|
74
|
+
},
|
|
75
|
+
"breadcrumb": {
|
|
76
|
+
"@type": "BreadcrumbList",
|
|
77
|
+
"itemListElement": [
|
|
78
|
+
{
|
|
79
|
+
"@type": "ListItem",
|
|
80
|
+
"position": 1,
|
|
81
|
+
"name": "@knowcode/doc-builder",
|
|
82
|
+
"item": "https://doc-builder-delta.vercel.app"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"@type": "ListItem",
|
|
86
|
+
"position": 2,
|
|
87
|
+
"name": "About Doc Builder",
|
|
88
|
+
"item": "https://doc-builder-delta.vercel.app/about-doc-builder.html"
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
</script>
|
|
94
|
+
</head>
|
|
95
|
+
<body>
|
|
96
|
+
<!-- Header -->
|
|
97
|
+
<header class="header">
|
|
98
|
+
<div class="header-content">
|
|
99
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
100
|
+
|
|
101
|
+
<div class="header-actions">
|
|
102
|
+
<div class="deployment-info">
|
|
103
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.20">Last updated: Aug 7, 2025, 11:50 AM UTC</span>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
109
|
+
<i class="fas fa-moon"></i>
|
|
110
|
+
</button>
|
|
111
|
+
|
|
112
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
113
|
+
<i class="fas fa-bars"></i>
|
|
114
|
+
</button>
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
</header>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
<!-- Breadcrumbs -->
|
|
122
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
123
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
124
|
+
</nav>
|
|
125
|
+
|
|
126
|
+
<!-- Main Content -->
|
|
127
|
+
<div class="main-wrapper">
|
|
128
|
+
<!-- Sidebar -->
|
|
129
|
+
<aside class="sidebar">
|
|
130
|
+
<div class="sidebar-header">
|
|
131
|
+
<div class="filter-box">
|
|
132
|
+
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
133
|
+
<i class="fas fa-search filter-icon"></i>
|
|
134
|
+
</div>
|
|
135
|
+
</div>
|
|
136
|
+
<nav class="navigation">
|
|
137
|
+
|
|
138
|
+
<div class="nav-section" data-level="0">
|
|
139
|
+
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
140
|
+
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
141
|
+
</a>
|
|
142
|
+
<div class="nav-content">
|
|
143
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
144
|
+
<a href="/about-doc-builder.html" class="nav-item active" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #059669;"></i> About Doc Builder</a>
|
|
145
|
+
<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>
|
|
146
|
+
<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>
|
|
147
|
+
<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>
|
|
148
|
+
<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>
|
|
149
|
+
<div class="nav-section" data-level="1">
|
|
150
|
+
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
151
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
152
|
+
</a>
|
|
153
|
+
<div class="nav-content collapsed" id="nav-guides-1">
|
|
154
|
+
<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>
|
|
155
|
+
<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>
|
|
156
|
+
<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>
|
|
157
|
+
<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>
|
|
158
|
+
<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>
|
|
159
|
+
<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>
|
|
160
|
+
<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>
|
|
161
|
+
<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>
|
|
162
|
+
<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>
|
|
163
|
+
<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>
|
|
164
|
+
<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>
|
|
165
|
+
<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>
|
|
166
|
+
<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>
|
|
167
|
+
<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>
|
|
168
|
+
<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>
|
|
169
|
+
<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>
|
|
170
|
+
<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>
|
|
171
|
+
<div class="nav-section" data-level="1">
|
|
172
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
173
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
174
|
+
</a>
|
|
175
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
176
|
+
<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>
|
|
177
|
+
<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>
|
|
178
|
+
<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>
|
|
179
|
+
<div class="nav-section" data-level="1">
|
|
180
|
+
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
181
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
182
|
+
</a>
|
|
183
|
+
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
184
|
+
<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>
|
|
185
|
+
<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>
|
|
186
|
+
<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>
|
|
187
|
+
</nav>
|
|
188
|
+
<div class="resize-handle"></div>
|
|
189
|
+
</aside>
|
|
190
|
+
|
|
191
|
+
<!-- Content Area -->
|
|
192
|
+
<main class="content">
|
|
193
|
+
<div class="content-inner">
|
|
194
|
+
<h1>About @knowcode/doc-builder</h1>
|
|
195
|
+
<p><em>This documentation site was built with @knowcode/doc-builder - a zero-configuration documentation generator that transforms markdown files into beautiful static sites.</em></p>
|
|
196
|
+
<hr>
|
|
197
|
+
<h2><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> What is @knowcode/doc-builder?</h2>
|
|
198
|
+
<p><strong>@knowcode/doc-builder</strong> is a modern documentation generator that creates stunning, Notion-inspired static websites from your markdown files. Built by <strong>Knowcode Ltd</strong>, it eliminates the complexity of traditional documentation tools while providing enterprise-grade features.</p>
|
|
199
|
+
<h3><i style="font-size: 1.2em" class="ph ph-sparkle" aria-label="special"></i> Core Features</h3>
|
|
200
|
+
<table>
|
|
201
|
+
<thead>
|
|
202
|
+
<tr>
|
|
203
|
+
<th>Feature</th>
|
|
204
|
+
<th>Description</th>
|
|
205
|
+
</tr>
|
|
206
|
+
</thead>
|
|
207
|
+
<tbody><tr>
|
|
208
|
+
<td><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> <strong>Zero Configuration</strong></td>
|
|
209
|
+
<td>Works out of the box - no setup files or complex configuration</td>
|
|
210
|
+
</tr>
|
|
211
|
+
<tr>
|
|
212
|
+
<td><i style="font-size: 1.2em" class="ph ph-note-pencil" aria-label="edit"></i> <strong>Markdown Native</strong></td>
|
|
213
|
+
<td>Full GitHub Flavored Markdown support with syntax highlighting</td>
|
|
214
|
+
</tr>
|
|
215
|
+
<tr>
|
|
216
|
+
<td><i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> <strong>Beautiful Design</strong></td>
|
|
217
|
+
<td>Notion-inspired theme with dark mode and responsive layout</td>
|
|
218
|
+
</tr>
|
|
219
|
+
<tr>
|
|
220
|
+
<td><i style="font-size: 1.2em" class="ph ph-cloud" aria-label="cloud"></i> <strong>One-Click Deploy</strong></td>
|
|
221
|
+
<td>Deploy to Vercel with a single command using their generous free tier</td>
|
|
222
|
+
</tr>
|
|
223
|
+
<tr>
|
|
224
|
+
<td><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> <strong>Mermaid Diagrams</strong></td>
|
|
225
|
+
<td>Enhanced styling with rounded corners & Notion-inspired themes</td>
|
|
226
|
+
</tr>
|
|
227
|
+
<tr>
|
|
228
|
+
<td><i style="font-size: 1.2em" class="ph ph-image" aria-label="picture"></i> <strong>Image Modals</strong></td>
|
|
229
|
+
<td>Click any image for full-screen viewing</td>
|
|
230
|
+
</tr>
|
|
231
|
+
<tr>
|
|
232
|
+
<td><i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> <strong>SEO Ready</strong></td>
|
|
233
|
+
<td>Automatic meta tags, structured data, and search engine optimization</td>
|
|
234
|
+
</tr>
|
|
235
|
+
</tbody></table>
|
|
236
|
+
<h2><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Enterprise Security & Authentication</h2>
|
|
237
|
+
<p><strong>@knowcode/doc-builder</strong> includes enterprise-grade security powered by <strong>Supabase</strong>, providing bank-level protection for your documentation.</p>
|
|
238
|
+
<h3><i style="font-size: 1.2em" class="ph ph-shield" aria-label="security"></i> Security Features</h3>
|
|
239
|
+
<ul>
|
|
240
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-lock" aria-label="locked"></i> JWT Authentication</strong>: Industry-standard secure token-based authentication</li>
|
|
241
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-crane" aria-label="construction"></i> Zero Configuration</strong>: Built-in Supabase credentials - just enable and deploy</li>
|
|
242
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-globe" aria-label="global"></i> Domain-Based Access</strong>: Automatic access control using your deployment domain</li>
|
|
243
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-folder" aria-label="folder"></i> Private Directories</strong>: <code>/private/</code> folders automatically protected</li>
|
|
244
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-arrows-clockwise" aria-label="refresh"></i> Session Management</strong>: Auto-refresh tokens with persistent sessions</li>
|
|
245
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-users" aria-label="team"></i> Multi-User Support</strong>: Unlimited users with fine-grained access control</li>
|
|
246
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-shield" aria-label="security"></i> Row Level Security</strong>: Database-level access control policies</li>
|
|
247
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Password Security</strong>: bcrypt hashing with salt for password storage</li>
|
|
248
|
+
</ul>
|
|
249
|
+
<h3><i style="font-size: 1.2em" class="ph ph-buildings" aria-label="office"></i> Authentication Modes</h3>
|
|
250
|
+
<table>
|
|
251
|
+
<thead>
|
|
252
|
+
<tr>
|
|
253
|
+
<th>Mode</th>
|
|
254
|
+
<th>Use Case</th>
|
|
255
|
+
<th>Implementation</th>
|
|
256
|
+
</tr>
|
|
257
|
+
</thead>
|
|
258
|
+
<tbody><tr>
|
|
259
|
+
<td><strong><i style="font-size: 1.2em" class="ph ph-globe-hemisphere-west" aria-label="world"></i> Global Auth</strong></td>
|
|
260
|
+
<td>Entire site requires login</td>
|
|
261
|
+
<td><code>authentication: 'supabase'</code></td>
|
|
262
|
+
</tr>
|
|
263
|
+
<tr>
|
|
264
|
+
<td><strong><i style="font-size: 1.2em" class="ph ph-folder" aria-label="folder"></i> Private Directory</strong></td>
|
|
265
|
+
<td>Public docs + private sections</td>
|
|
266
|
+
<td>Create <code>/private/</code> folder</td>
|
|
267
|
+
</tr>
|
|
268
|
+
<tr>
|
|
269
|
+
<td><strong><i style="font-size: 1.2em" class="ph ph-arrows-clockwise" aria-label="refresh"></i> Hybrid</strong></td>
|
|
270
|
+
<td>Complex access requirements</td>
|
|
271
|
+
<td>Combine both modes</td>
|
|
272
|
+
</tr>
|
|
273
|
+
</tbody></table>
|
|
274
|
+
<h3><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Quick Authentication Setup</h3>
|
|
275
|
+
<pre><code class="language-bash"># Create private documentation - authentication automatically enabled
|
|
276
|
+
mkdir docs/private
|
|
277
|
+
echo "# Confidential Documentation" > docs/private/admin.md
|
|
278
|
+
npx @knowcode/doc-builder deploy
|
|
279
|
+
</code></pre>
|
|
280
|
+
<p><strong>That's it!</strong> Your site now has enterprise authentication with beautiful login pages.</p>
|
|
281
|
+
<h2><i style="font-size: 1.2em" class="ph ph-crane" aria-label="construction"></i> How It Works</h2>
|
|
282
|
+
<ol>
|
|
283
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-book-open" aria-label="reading"></i> Scan</strong>: Automatically discovers markdown files in your project</li>
|
|
284
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-arrows-clockwise" aria-label="refresh"></i> Convert</strong>: Transforms markdown to HTML with syntax highlighting</li>
|
|
285
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> Style</strong>: Applies beautiful Notion-inspired design</li>
|
|
286
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-folders" aria-label="folders"></i> Navigate</strong>: Generates navigation from your folder structure</li>
|
|
287
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Secure</strong>: Protects private content with Supabase authentication</li>
|
|
288
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Deploy</strong>: One-command deployment to Vercel's global CDN</li>
|
|
289
|
+
</ol>
|
|
290
|
+
<h2><i style="font-size: 1.2em" class="ph ph-gear-six" aria-label="tools"></i> Getting Started</h2>
|
|
291
|
+
<h3>Installation & Usage</h3>
|
|
292
|
+
<pre><code class="language-bash"># Generate documentation from markdown files
|
|
293
|
+
npx @knowcode/doc-builder@latest build
|
|
294
|
+
|
|
295
|
+
# Deploy to Vercel with one command
|
|
296
|
+
npx @knowcode/doc-builder@latest deploy
|
|
297
|
+
|
|
298
|
+
# Start local development server
|
|
299
|
+
npx @knowcode/doc-builder@latest dev
|
|
300
|
+
</code></pre>
|
|
301
|
+
<h3>Project Structure</h3>
|
|
302
|
+
<pre><code>docs/
|
|
303
|
+
├── README.md # Homepage content
|
|
304
|
+
├── guides/ # Organized documentation
|
|
305
|
+
│ ├── getting-started.md
|
|
306
|
+
│ └── advanced-usage.md
|
|
307
|
+
├── private/ # 🔐 Requires authentication
|
|
308
|
+
│ └── admin-guide.md
|
|
309
|
+
└── assets/ # Images and attachments
|
|
310
|
+
└── logo.png
|
|
311
|
+
</code></pre>
|
|
312
|
+
<h2><i style="font-size: 1.2em" class="ph ph-user-circle" aria-label="developer"></i> Created by Knowcode Ltd</h2>
|
|
313
|
+
<p><strong>Knowcode Ltd</strong> is a software consultancy and product development company specializing in intelligent automation and developer tools. We build products for both clients and internal use, with a focus on reducing complexity while maintaining enterprise-grade capabilities.</p>
|
|
314
|
+
<h3><i style="font-size: 1.2em" class="ph ph-target" aria-label="goal"></i> Our Philosophy</h3>
|
|
315
|
+
<blockquote>
|
|
316
|
+
<p><em>"Beautiful documentation should be accessible to everyone, without worrying about hosting costs or complex server management."</em></p>
|
|
317
|
+
</blockquote>
|
|
318
|
+
<p>We believe that great documentation shouldn't require a PhD in DevOps. That's why @knowcode/doc-builder works with zero configuration and deploys to Vercel's generous free tier.</p>
|
|
319
|
+
<h2><i style="font-size: 1.2em" class="ph ph-link" aria-label="link"></i> Learn More</h2>
|
|
320
|
+
<h3><i style="font-size: 1.2em" class="ph ph-books" aria-label="documentation"></i> Documentation & Resources</h3>
|
|
321
|
+
<ul>
|
|
322
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-package" aria-label="package"></i> NPM Package</strong>: <a href="https://www.npmjs.com/package/@knowcode/doc-builder">npmjs.com/package/@knowcode/doc-builder</a></li>
|
|
323
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-globe" aria-label="global"></i> Live Demo</strong>: <a href="https://doc-builder-delta.vercel.app">doc-builder-delta.vercel.app</a></li>
|
|
324
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-book-open" aria-label="reading"></i> GitHub Repository</strong>: <a href="https://github.com/wapdat/doc-builder">github.com/wapdat/doc-builder</a></li>
|
|
325
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Authentication Guide</strong>: <a href="https://doc-builder-delta.vercel.app/guides/supabase-authentication-complete-guide.html">Complete Supabase Setup</a></li>
|
|
326
|
+
</ul>
|
|
327
|
+
<h3><i style="font-size: 1.2em" class="ph ph-first-aid" aria-label="emergency"></i> Support & Community</h3>
|
|
328
|
+
<ul>
|
|
329
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-bug" aria-label="bug"></i> Issue Tracker</strong>: <a href="https://github.com/wapdat/doc-builder/issues">GitHub Issues</a></li>
|
|
330
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-chat-circle" aria-label="chat"></i> Discussions</strong>: <a href="https://github.com/wapdat/doc-builder/discussions">GitHub Discussions</a></li>
|
|
331
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-envelope" aria-label="email"></i> Enterprise Support</strong>: Contact Knowcode Ltd for custom implementations</li>
|
|
332
|
+
</ul>
|
|
333
|
+
<h2><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Why Choose @knowcode/doc-builder?</h2>
|
|
334
|
+
<h3>🆚 Comparison with Other Tools</h3>
|
|
335
|
+
<table>
|
|
336
|
+
<thead>
|
|
337
|
+
<tr>
|
|
338
|
+
<th>Feature</th>
|
|
339
|
+
<th>@knowcode/doc-builder</th>
|
|
340
|
+
<th>GitBook</th>
|
|
341
|
+
<th>Notion</th>
|
|
342
|
+
<th>Confluence</th>
|
|
343
|
+
</tr>
|
|
344
|
+
</thead>
|
|
345
|
+
<tbody><tr>
|
|
346
|
+
<td><strong>Setup Time</strong></td>
|
|
347
|
+
<td>0 minutes</td>
|
|
348
|
+
<td>30+ minutes</td>
|
|
349
|
+
<td>Manual work</td>
|
|
350
|
+
<td>Hours</td>
|
|
351
|
+
</tr>
|
|
352
|
+
<tr>
|
|
353
|
+
<td><strong>Hosting Cost</strong></td>
|
|
354
|
+
<td>Free (Vercel)</td>
|
|
355
|
+
<td>$99+/month</td>
|
|
356
|
+
<td>$8+/user</td>
|
|
357
|
+
<td>$5+/user</td>
|
|
358
|
+
</tr>
|
|
359
|
+
<tr>
|
|
360
|
+
<td><strong>Authentication</strong></td>
|
|
361
|
+
<td>Enterprise (Supabase)</td>
|
|
362
|
+
<td>Premium only</td>
|
|
363
|
+
<td>Basic</td>
|
|
364
|
+
<td>Enterprise</td>
|
|
365
|
+
</tr>
|
|
366
|
+
<tr>
|
|
367
|
+
<td><strong>Customization</strong></td>
|
|
368
|
+
<td>Full control</td>
|
|
369
|
+
<td>Limited</td>
|
|
370
|
+
<td>None</td>
|
|
371
|
+
<td>Complex</td>
|
|
372
|
+
</tr>
|
|
373
|
+
<tr>
|
|
374
|
+
<td><strong>Markdown Support</strong></td>
|
|
375
|
+
<td>Native</td>
|
|
376
|
+
<td>Partial</td>
|
|
377
|
+
<td>Import only</td>
|
|
378
|
+
<td>Plugin</td>
|
|
379
|
+
</tr>
|
|
380
|
+
<tr>
|
|
381
|
+
<td><strong>Version Control</strong></td>
|
|
382
|
+
<td>Git native</td>
|
|
383
|
+
<td>Limited</td>
|
|
384
|
+
<td>None</td>
|
|
385
|
+
<td>Plugin</td>
|
|
386
|
+
</tr>
|
|
387
|
+
</tbody></table>
|
|
388
|
+
<h3><i style="font-size: 1.2em" class="ph ph-target" aria-label="goal"></i> Perfect For</h3>
|
|
389
|
+
<ul>
|
|
390
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-clipboard-text" aria-label="clipboard"></i> Project Documentation</strong>: API references, user guides, developer docs</li>
|
|
391
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-buildings" aria-label="office"></i> Internal Knowledge Bases</strong>: Company wikis, process documentation</li>
|
|
392
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-lock-key" aria-label="secure"></i> Secure Documentation</strong>: Confidential guides, admin documentation </li>
|
|
393
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Startup Teams</strong>: Fast-moving teams who need docs without overhead</li>
|
|
394
|
+
<li><strong><i style="font-size: 1.2em" class="ph ph-robot" aria-label="automation"></i> AI-Assisted Workflows</strong>: Optimized for Claude Code and AI development</li>
|
|
395
|
+
</ul>
|
|
396
|
+
<h2><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Ready to Get Started?</h2>
|
|
397
|
+
<p>Transform your markdown files into beautiful documentation in under 2 minutes:</p>
|
|
398
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
399
|
+
</code></pre>
|
|
400
|
+
<p><em>Experience the power of zero-configuration documentation with enterprise-grade security.</em></p>
|
|
401
|
+
<hr>
|
|
402
|
+
<div style="text-align: center; padding: 2rem; background: var(--bg-secondary); border-radius: 8px; margin: 2rem 0;">
|
|
403
|
+
|
|
404
|
+
<p><strong>Generated with <a href="https://www.npmjs.com/package/@knowcode/doc-builder">@knowcode/doc-builder</a></strong><br><em>Beautiful documentation with the least effort possible</em></p>
|
|
405
|
+
<p><strong>Created by <a href="https://github.com/wapdat">Knowcode Ltd</a></strong> | <strong><a href="https://doc-builder-delta.vercel.app">Try it now →</a></strong></p>
|
|
406
|
+
</div>
|
|
407
|
+
</div>
|
|
408
|
+
</main>
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
<!-- Scripts -->
|
|
412
|
+
<script>
|
|
413
|
+
// Pass configuration to frontend
|
|
414
|
+
window.docBuilderConfig = {
|
|
415
|
+
features: {
|
|
416
|
+
showPdfDownload: true,
|
|
417
|
+
menuDefaultOpen: false,
|
|
418
|
+
mermaidEnhanced: true
|
|
419
|
+
}
|
|
420
|
+
};
|
|
421
|
+
</script>
|
|
422
|
+
<script src="/js/main.js"></script>
|
|
423
|
+
|
|
424
|
+
</body>
|
|
425
|
+
</html>
|