@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.
Files changed (86) hide show
  1. package/cli.js +15 -1
  2. package/doc-builder.config.js +4 -2
  3. package/doc-builder.config.js.backup.1754567425847 +124 -0
  4. package/html/README.html +3 -3
  5. package/html/about-doc-builder.html +3 -3
  6. package/html/documentation-index.html +3 -3
  7. package/html/guides/authentication-default-change.html +3 -3
  8. package/html/guides/authentication-guide.html +3 -3
  9. package/html/guides/claude-workflow-guide.html +3 -3
  10. package/html/guides/configuration-guide.html +3 -3
  11. package/html/guides/documentation-standards.html +3 -3
  12. package/html/guides/html-embedding-guide.html +3 -3
  13. package/html/guides/image-modal-guide.html +3 -3
  14. package/html/guides/phosphor-icons-guide.html +3 -3
  15. package/html/guides/private-directory-authentication-troubleshooting.html +3 -3
  16. package/html/guides/private-directory-authentication.html +3 -3
  17. package/html/guides/public-site-deployment.html +3 -3
  18. package/html/guides/search-engine-verification-guide.html +3 -3
  19. package/html/guides/seo-guide.html +3 -3
  20. package/html/guides/seo-optimization-guide.html +3 -3
  21. package/html/guides/supabase-authentication-complete-guide.html +3 -3
  22. package/html/guides/troubleshooting-guide.html +3 -3
  23. package/html/guides/windows-setup-guide.html +3 -3
  24. package/html/image-modal-test.html +3 -3
  25. package/html/index.html +3 -3
  26. package/html/private/cache-control-anti-pattern.html +3 -3
  27. package/html/private/launch/README.html +3 -3
  28. package/html/private/launch/auth-cleanup-summary.html +3 -3
  29. package/html/private/launch/bubble-plugin-specification.html +3 -3
  30. package/html/private/launch/go-to-market-strategy.html +3 -3
  31. package/html/private/launch/launch-announcements.html +3 -3
  32. package/html/private/launch/vercel-deployment-auth-setup.html +3 -3
  33. package/html/private/next-steps-walkthrough.html +3 -3
  34. package/html/private/supabase-auth-implementation-completed.html +3 -3
  35. package/html/private/supabase-auth-implementation-plan.html +3 -3
  36. package/html/private/supabase-auth-integration-plan.html +3 -3
  37. package/html/private/supabase-auth-setup-guide.html +3 -3
  38. package/html/private/test-private-doc.html +3 -3
  39. package/html/private/user-management-tooling.html +3 -3
  40. package/html/prompts/beautiful-documentation-design.html +3 -3
  41. package/html/prompts/markdown-document-standards.html +3 -3
  42. package/html/prompts/project-rename-strategy-sasha-publish.html +3 -3
  43. package/html/sitemap.xml +59 -59
  44. package/html/test-questions/how-does-it-work%3F.html +3 -3
  45. package/html/test-questions/step-1%3A%20getting-started.html +3 -3
  46. package/html/test-questions/what-is-the-purpose.html +3 -3
  47. package/html/vercel-cli-setup-guide.html +3 -3
  48. package/html/vercel-first-time-setup-guide.html +3 -3
  49. package/html-static/404.html +115 -0
  50. package/html-static/README.html +456 -0
  51. package/html-static/about-doc-builder.html +425 -0
  52. package/html-static/css/notion-style.css +2426 -0
  53. package/html-static/documentation-index.html +405 -0
  54. package/html-static/guides/authentication-default-change.html +304 -0
  55. package/html-static/guides/authentication-guide.html +443 -0
  56. package/html-static/guides/claude-workflow-guide.html +1008 -0
  57. package/html-static/guides/configuration-guide.html +406 -0
  58. package/html-static/guides/documentation-standards.html +628 -0
  59. package/html-static/guides/html-embedding-guide.html +395 -0
  60. package/html-static/guides/image-modal-guide.html +449 -0
  61. package/html-static/guides/phosphor-icons-guide.html +518 -0
  62. package/html-static/guides/private-directory-authentication-troubleshooting.html +489 -0
  63. package/html-static/guides/private-directory-authentication.html +475 -0
  64. package/html-static/guides/public-site-deployment.html +365 -0
  65. package/html-static/guides/search-engine-verification-guide.html +476 -0
  66. package/html-static/guides/seo-guide.html +595 -0
  67. package/html-static/guides/seo-optimization-guide.html +821 -0
  68. package/html-static/guides/supabase-authentication-complete-guide.html +800 -0
  69. package/html-static/guides/troubleshooting-guide.html +567 -0
  70. package/html-static/guides/windows-setup-guide.html +793 -0
  71. package/html-static/image-modal-test.html +252 -0
  72. package/html-static/index.html +456 -0
  73. package/html-static/js/main.js +1692 -0
  74. package/html-static/prompts/beautiful-documentation-design.html +718 -0
  75. package/html-static/prompts/markdown-document-standards.html +356 -0
  76. package/html-static/prompts/project-rename-strategy-sasha-publish.html +464 -0
  77. package/html-static/robots.txt +5 -0
  78. package/html-static/sitemap.xml +189 -0
  79. package/html-static/test-questions/how-does-it-work%3F.html +228 -0
  80. package/html-static/test-questions/step-1%3A%20getting-started.html +223 -0
  81. package/html-static/test-questions/what-is-the-purpose.html +227 -0
  82. package/html-static/vercel-cli-setup-guide.html +429 -0
  83. package/html-static/vercel-first-time-setup-guide.html +388 -0
  84. package/lib/config.js +9 -2
  85. package/lib/core-builder.js +148 -4
  86. package/package.json +1 -1
@@ -0,0 +1,456 @@
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="&lt;div align=&quot;center&quot;&gt;">
7
+ <title>@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, width, table">
12
+ <meta name="robots" content="index, follow">
13
+ <link rel="canonical" href="https://doc-builder-delta.vercel.app/README.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/README.html">
18
+ <meta property="og:title" content="@knowcode/doc-builder | @knowcode/doc-builder">
19
+ <meta property="og:description" content="&lt;div align=&quot;center&quot;&gt;">
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="@knowcode/doc-builder | @knowcode/doc-builder">
29
+ <meta name="twitter:description" content="&lt;div align=&quot;center&quot;&gt;">
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": "@knowcode/doc-builder",
59
+ "description": "<div align=\"center\">",
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.058Z",
70
+ "dateModified": "2025-08-07T11:50:26.058Z",
71
+ "mainEntityOfPage": {
72
+ "@type": "WebPage",
73
+ "@id": "https://doc-builder-delta.vercel.app/README.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": "README",
88
+ "item": "https://doc-builder-delta.vercel.app/README.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 active" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
144
+ <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>
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 expanded" 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" 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 expanded" 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" 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 &quot;sasha-publish&quot;, 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 expanded" 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" 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>@knowcode/doc-builder</h1>
195
+ <div align="center">
196
+
197
+ <blockquote>
198
+ <p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
199
+ </blockquote>
200
+ <p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><img src="https://img.shields.io/npm/v/@knowcode/doc-builder" alt="npm version"></a><br><a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a></p>
201
+ <h3><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h3>
202
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
203
+ </code></pre>
204
+ <p><a href="https://doc-builder-delta.vercel.app"><strong>You are looking at a demo</strong></a> | <a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>NPM Package</strong></a> | <a href="https://github.com/wapdat/doc-builder"><strong>GitHub</strong></a></p>
205
+ </div>
206
+
207
+ <hr>
208
+ <h2><i style="font-size: 1.2em" class="ph ph-sparkle" aria-label="special"></i> Features</h2>
209
+ <table>
210
+ <tr>
211
+ <td width="50%">
212
+
213
+ <h3><i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> Design &amp; UX</h3>
214
+ <ul>
215
+ <li><strong>Notion-inspired UI</strong> - Clean, modern interface</li>
216
+ <li><strong>Dark mode support</strong> - Automatic theme switching</li>
217
+ <li><strong>Responsive layout</strong> - Perfect on any device</li>
218
+ <li><strong>Syntax highlighting</strong> - Beautiful code blocks</li>
219
+ </ul>
220
+ <h3><i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> Navigation</h3>
221
+ <ul>
222
+ <li><strong>Full-text search</strong> - Find anything instantly</li>
223
+ <li><strong>Smart navigation</strong> - Hierarchical structure</li>
224
+ <li><strong>Breadcrumbs</strong> - Always know where you are</li>
225
+ <li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
226
+ </ul>
227
+ </td>
228
+ <td width="50%">
229
+
230
+ <h3><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Content Support</h3>
231
+ <ul>
232
+ <li><strong>Mermaid diagrams</strong> - Visual documentation</li>
233
+ <li><strong>GitHub markdown</strong> - Full GFM support</li>
234
+ <li><strong>Interactive tooltips</strong> - Document previews</li>
235
+ <li><strong>Version tracking</strong> - Build metadata</li>
236
+ </ul>
237
+ <h3><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Deployment</h3>
238
+ <ul>
239
+ <li><strong>One-command deploy</strong> - Push to Vercel</li>
240
+ <li><strong>Static generation</strong> - Fast &amp; secure</li>
241
+ <li><strong>Custom domains</strong> - Your brand</li>
242
+ <li><strong>Preview deploys</strong> - Test changes</li>
243
+ </ul>
244
+ </td>
245
+ </tr>
246
+ </table>
247
+
248
+ <h2><i style="font-size: 1.2em" class="ph ph-target" aria-label="goal"></i> Use Cases</h2>
249
+ <table>
250
+ <tr>
251
+ <td width="25%">
252
+
253
+ <h3>Open Source</h3>
254
+ <p>Beautiful docs for your community</p>
255
+ </td>
256
+ <td width="25%">
257
+
258
+ <h3>Technical Teams</h3>
259
+ <p>Internal docs developers love</p>
260
+ </td>
261
+ <td width="25%">
262
+
263
+ <h3>API Docs</h3>
264
+ <p>Clear, searchable references</p>
265
+ </td>
266
+ <td width="25%">
267
+
268
+ <h3>Knowledge Base</h3>
269
+ <p>Organize team knowledge</p>
270
+ </td>
271
+ </tr>
272
+ </table>
273
+
274
+ <h2><i style="font-size: 1.2em" class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
275
+ <table>
276
+ <tr>
277
+ <td width="50%">
278
+
279
+ <h3>1️⃣ Setup</h3>
280
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest init
281
+ </code></pre>
282
+ <p><em>Create project structure and configure doc-builder</em></p>
283
+ </td>
284
+ <td width="50%">
285
+
286
+ <h3>2️⃣ Deploy</h3>
287
+ <pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
288
+ </code></pre>
289
+ <p><em>Build your markdown files and deploy to production</em></p>
290
+ </td>
291
+ </tr>
292
+ </table>
293
+
294
+ <h2><i style="font-size: 1.2em" class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
295
+ <p>Configuration is fully managed through the CLI tools - no manual file editing required! The tool handles all settings automatically during setup and deployment.</p>
296
+ <h3><i style="font-size: 1.2em" class="ph ph-arrows-clockwise" aria-label="refresh"></i> Auto-Configuration</h3>
297
+ <ul>
298
+ <li><strong>Auto-creation</strong>: If no <code>doc-builder.config.js</code> exists, one is created with all default settings</li>
299
+ <li><strong>Auto-update</strong>: When upgrading versions, new features are automatically added to your config</li>
300
+ <li><strong>Safe migration</strong>: Your customizations are preserved while adding new defaults</li>
301
+ <li><strong>Backup protection</strong>: Config files are backed up before major updates</li>
302
+ </ul>
303
+ <table>
304
+ <tr>
305
+ <td width="50%">
306
+
307
+ <h3>Basic Config (Reference Only)</h3>
308
+ <pre><code class="language-javascript">// doc-builder.config.js
309
+ // This file is auto-generated and managed by the CLI
310
+ module.exports = {
311
+ siteName: &#39;@knowcode/doc-builder&#39;,
312
+ siteDescription: &#39;Transform markdown into beautiful documentation&#39;,
313
+ docsDir: &#39;docs&#39;,
314
+ outputDir: &#39;html&#39;,
315
+ favicon: &#39;✨&#39; // Can be emoji or path to image
316
+ };
317
+ </code></pre>
318
+ <p><em>The CLI creates and updates this for you</em></p>
319
+ </td>
320
+ <td width="50%">
321
+
322
+ <h3>Advanced Features (Reference Only)</h3>
323
+ <pre><code class="language-javascript">// Also managed via CLI commands
324
+ features: {
325
+ mermaid: true, // Diagrams
326
+ darkMode: true, // Theme toggle
327
+ authentication: true, // Password
328
+ changelog: true // Auto-generate
329
+ }
330
+ </code></pre>
331
+ <p><em>Use <code>init</code> or <code>deploy</code> commands to configure</em></p>
332
+ </td>
333
+ </tr>
334
+ </table>
335
+
336
+ <h2><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Examples</h2>
337
+ <table>
338
+ <tr>
339
+ <td width="50%">
340
+
341
+ <h3>Mermaid Diagrams</h3>
342
+ <div class="mermaid-wrapper">
343
+ <div class="mermaid">graph LR
344
+ A[Write] --> B[Build]
345
+ B --> C[Deploy]
346
+ C --> D[Share]
347
+
348
+ style A fill:#e1f5fe
349
+ style D fill:#c8e6c9</div>
350
+ </div>
351
+ </td>
352
+ <td width="50%">
353
+
354
+ <h3>Code with Syntax Highlighting</h3>
355
+ <pre><code class="language-javascript">// Beautiful code blocks
356
+ const docBuilder = require(&#39;@knowcode/doc-builder&#39;);
357
+
358
+ docBuilder.build({
359
+ siteName: &#39;@knowcode/doc-builder&#39;,
360
+ features: { darkMode: true }
361
+ });
362
+ </code></pre>
363
+ </td>
364
+ </tr>
365
+ </table>
366
+
367
+ <h2><i style="font-size: 1.2em" class="ph ph-star-four" aria-label="sparkle"></i> Why Choose doc-builder?</h2>
368
+ <table>
369
+ <tr>
370
+ <td width="33%">
371
+
372
+ <h3><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> Performance</h3>
373
+ <ul>
374
+ <li><strong>Lightning fast</strong> - Static generation</li>
375
+ <li><strong>SEO optimized</strong> - Search friendly</li>
376
+ <li><strong>Accessible</strong> - WCAG compliant</li>
377
+ </ul>
378
+ </td>
379
+ <td width="33%">
380
+
381
+ <h3><i style="font-size: 1.2em" class="ph ph-gear-six" aria-label="tools"></i> Developer Experience</h3>
382
+ <ul>
383
+ <li><strong>Zero config</strong> - Works instantly</li>
384
+ <li><strong>Version control</strong> - Git-friendly</li>
385
+ <li><strong>Open source</strong> - MIT licensed</li>
386
+ </ul>
387
+ </td>
388
+ <td width="33%">
389
+
390
+ <h3><i style="font-size: 1.2em" class="ph ph-money" aria-label="money"></i> Cost Effective</h3>
391
+ <ul>
392
+ <li><strong>Free hosting</strong> - Vercel free tier</li>
393
+ <li><strong>No vendor lock-in</strong> - Your content</li>
394
+ <li><strong>Export anywhere</strong> - Static HTML</li>
395
+ </ul>
396
+ </td>
397
+ </tr>
398
+ </table>
399
+
400
+ <h2><i style="font-size: 1.2em" class="ph ph-handshake" aria-label="partnership"></i> Get Involved</h2>
401
+ <table>
402
+ <tr>
403
+ <td width="50%">
404
+
405
+ <h3>Contributing</h3>
406
+ <p>We welcome contributions! Check our <a href="https://github.com/wapdat/doc-builder">contribution guide</a> to get started.</p>
407
+ <p><strong>Ways to help:</strong></p>
408
+ <ul>
409
+ <li><i style="font-size: 1.2em" class="ph ph-bug" aria-label="bug"></i> Report bugs</li>
410
+ <li><i style="font-size: 1.2em" class="ph ph-lightbulb" aria-label="idea"></i> Suggest features</li>
411
+ <li><i style="font-size: 1.2em" class="ph ph-note-pencil" aria-label="edit"></i> Improve docs</li>
412
+ <li><i style="font-size: 1.2em" class="ph ph-wrench" aria-label="settings"></i> Submit PRs</li>
413
+ </ul>
414
+ </td>
415
+ <td width="50%">
416
+
417
+ <h3>Community</h3>
418
+ <p>Join our growing community of documentation enthusiasts!</p>
419
+ <p><strong>Connect with us:</strong></p>
420
+ <ul>
421
+ <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>
422
+ <li><i style="font-size: 1.2em" class="ph ph-github-logo" aria-label="github"></i> <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
423
+ <li><i style="font-size: 1.2em" class="ph ph-globe" aria-label="global"></i> <a href="https://knowcode.com">Website</a></li>
424
+ <li><i style="font-size: 1.2em" class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
425
+ </ul>
426
+ </td>
427
+ </tr>
428
+ </table>
429
+
430
+ <hr>
431
+ <div align="center">
432
+
433
+ <h3><i style="font-size: 1.2em" class="ph ph-note-pencil" aria-label="edit"></i> License: MIT © KnowCode</h3>
434
+ <p>Built with <i style="font-size: 1.2em" class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
435
+ <p><a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>Get Started</strong></a> | <a href="https://doc-builder-delta.vercel.app"><strong>You are looking at a demo</strong></a> | <a href="https://github.com/wapdat/doc-builder"><strong>Star on GitHub</strong></a></p>
436
+ </div>
437
+
438
+ </div>
439
+ </main>
440
+ </div>
441
+
442
+ <!-- Scripts -->
443
+ <script>
444
+ // Pass configuration to frontend
445
+ window.docBuilderConfig = {
446
+ features: {
447
+ showPdfDownload: true,
448
+ menuDefaultOpen: false,
449
+ mermaidEnhanced: true
450
+ }
451
+ };
452
+ </script>
453
+ <script src="/js/main.js"></script>
454
+
455
+ </body>
456
+ </html>