@knowcode/doc-builder 1.9.19 → 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.1754384764054 +124 -0
- package/doc-builder.config.js.backup.1754567425847 +124 -0
- package/html/README.html +12 -4
- package/html/about-doc-builder.html +12 -4
- package/html/documentation-index.html +12 -4
- package/html/guides/authentication-default-change.html +12 -4
- package/html/guides/authentication-guide.html +12 -4
- package/html/guides/claude-workflow-guide.html +12 -4
- package/html/guides/configuration-guide.html +12 -4
- package/html/guides/documentation-standards.html +12 -4
- package/html/guides/html-embedding-guide.html +12 -4
- package/html/guides/image-modal-guide.html +12 -4
- package/html/guides/phosphor-icons-guide.html +12 -4
- package/html/guides/private-directory-authentication-troubleshooting.html +12 -4
- package/html/guides/private-directory-authentication.html +12 -4
- package/html/guides/public-site-deployment.html +12 -4
- package/html/guides/search-engine-verification-guide.html +12 -4
- package/html/guides/seo-guide.html +12 -4
- package/html/guides/seo-optimization-guide.html +12 -4
- package/html/guides/supabase-authentication-complete-guide.html +12 -4
- package/html/guides/troubleshooting-guide.html +12 -4
- package/html/guides/windows-setup-guide.html +12 -4
- package/html/image-modal-test.html +12 -4
- package/html/index.html +12 -4
- package/html/private/cache-control-anti-pattern.html +12 -4
- package/html/private/launch/README.html +12 -4
- package/html/private/launch/auth-cleanup-summary.html +12 -4
- package/html/private/launch/bubble-plugin-specification.html +12 -4
- package/html/private/launch/go-to-market-strategy.html +12 -4
- package/html/private/launch/launch-announcements.html +12 -4
- package/html/private/launch/vercel-deployment-auth-setup.html +12 -4
- package/html/private/next-steps-walkthrough.html +12 -4
- package/html/private/supabase-auth-implementation-completed.html +12 -4
- package/html/private/supabase-auth-implementation-plan.html +12 -4
- package/html/private/supabase-auth-integration-plan.html +12 -4
- package/html/private/supabase-auth-setup-guide.html +12 -4
- package/html/private/test-private-doc.html +12 -4
- package/html/private/user-management-tooling.html +12 -4
- package/html/prompts/beautiful-documentation-design.html +12 -4
- package/html/prompts/markdown-document-standards.html +12 -4
- package/html/prompts/project-rename-strategy-sasha-publish.html +12 -4
- package/html/sitemap.xml +74 -56
- package/html/test-questions/how-does-it-work%3F.html +290 -0
- package/html/test-questions/step-1%3A%20getting-started.html +285 -0
- package/html/test-questions/what-is-the-purpose.html +289 -0
- package/html/vercel-cli-setup-guide.html +12 -4
- package/html/vercel-first-time-setup-guide.html +12 -4
- 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 +167 -6
- package/package.json +1 -1
|
@@ -0,0 +1,406 @@
|
|
|
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 guide explains how @knowcode/doc-builder handles configuration files and settings.">
|
|
7
|
+
<title>Configuration Guide | @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, configuration, config">
|
|
12
|
+
<meta name="robots" content="index, follow">
|
|
13
|
+
<link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/configuration-guide.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/guides/configuration-guide.html">
|
|
18
|
+
<meta property="og:title" content="Configuration Guide | @knowcode/doc-builder">
|
|
19
|
+
<meta property="og:description" content="This guide explains how @knowcode/doc-builder handles configuration files and settings.">
|
|
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="Configuration Guide | @knowcode/doc-builder">
|
|
29
|
+
<meta name="twitter:description" content="This guide explains how @knowcode/doc-builder handles configuration files and settings.">
|
|
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": "Configuration Guide",
|
|
59
|
+
"description": "This guide explains how @knowcode/doc-builder handles configuration files and settings.",
|
|
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.070Z",
|
|
70
|
+
"dateModified": "2025-08-07T11:50:26.070Z",
|
|
71
|
+
"mainEntityOfPage": {
|
|
72
|
+
"@type": "WebPage",
|
|
73
|
+
"@id": "https://doc-builder-delta.vercel.app/guides/configuration-guide.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": "Guides",
|
|
88
|
+
"item": "https://doc-builder-delta.vercel.app/guides/"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"@type": "ListItem",
|
|
92
|
+
"position": 3,
|
|
93
|
+
"name": "Configuration Guide",
|
|
94
|
+
"item": "https://doc-builder-delta.vercel.app/guides/configuration-guide.html"
|
|
95
|
+
}
|
|
96
|
+
]
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
</script>
|
|
100
|
+
</head>
|
|
101
|
+
<body>
|
|
102
|
+
<!-- Header -->
|
|
103
|
+
<header class="header">
|
|
104
|
+
<div class="header-content">
|
|
105
|
+
<a href="/index.html" class="logo">@knowcode/doc-builder</a>
|
|
106
|
+
|
|
107
|
+
<div class="header-actions">
|
|
108
|
+
<div class="deployment-info">
|
|
109
|
+
<span class="deployment-date" title="Built with doc-builder v1.9.20">Last updated: Aug 7, 2025, 11:50 AM UTC</span>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
<button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
|
|
115
|
+
<i class="fas fa-moon"></i>
|
|
116
|
+
</button>
|
|
117
|
+
|
|
118
|
+
<button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
|
|
119
|
+
<i class="fas fa-bars"></i>
|
|
120
|
+
</button>
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
</header>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
<!-- Breadcrumbs -->
|
|
128
|
+
<nav class="breadcrumbs" id="breadcrumbs">
|
|
129
|
+
<!-- Breadcrumbs will be generated by JavaScript -->
|
|
130
|
+
</nav>
|
|
131
|
+
|
|
132
|
+
<!-- Main Content -->
|
|
133
|
+
<div class="main-wrapper">
|
|
134
|
+
<!-- Sidebar -->
|
|
135
|
+
<aside class="sidebar">
|
|
136
|
+
<div class="sidebar-header">
|
|
137
|
+
<div class="filter-box">
|
|
138
|
+
<input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
|
|
139
|
+
<i class="fas fa-search filter-icon"></i>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
<nav class="navigation">
|
|
143
|
+
|
|
144
|
+
<div class="nav-section" data-level="0">
|
|
145
|
+
<a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
|
|
146
|
+
<i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
|
|
147
|
+
</a>
|
|
148
|
+
<div class="nav-content">
|
|
149
|
+
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
|
|
150
|
+
<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>
|
|
151
|
+
<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>
|
|
152
|
+
<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>
|
|
153
|
+
<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>
|
|
154
|
+
<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>
|
|
155
|
+
<div class="nav-section" data-level="1">
|
|
156
|
+
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
157
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
|
|
158
|
+
</a>
|
|
159
|
+
<div class="nav-content" id="nav-guides-1">
|
|
160
|
+
<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>
|
|
161
|
+
<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>
|
|
162
|
+
<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>
|
|
163
|
+
<a href="/guides/configuration-guide.html" class="nav-item active" 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>
|
|
164
|
+
<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>
|
|
165
|
+
<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>
|
|
166
|
+
<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>
|
|
167
|
+
<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>
|
|
168
|
+
<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>
|
|
169
|
+
<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>
|
|
170
|
+
<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>
|
|
171
|
+
<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>
|
|
172
|
+
<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>
|
|
173
|
+
<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>
|
|
174
|
+
<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>
|
|
175
|
+
<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>
|
|
176
|
+
<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>
|
|
177
|
+
<div class="nav-section" data-level="1">
|
|
178
|
+
<a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
|
|
179
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
|
|
180
|
+
</a>
|
|
181
|
+
<div class="nav-content collapsed" id="nav-prompts-1">
|
|
182
|
+
<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>
|
|
183
|
+
<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>
|
|
184
|
+
<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>
|
|
185
|
+
<div class="nav-section" data-level="1">
|
|
186
|
+
<a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
|
|
187
|
+
<i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
|
|
188
|
+
</a>
|
|
189
|
+
<div class="nav-content collapsed" id="nav-test-questions-1">
|
|
190
|
+
<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>
|
|
191
|
+
<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>
|
|
192
|
+
<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>
|
|
193
|
+
</nav>
|
|
194
|
+
<div class="resize-handle"></div>
|
|
195
|
+
</aside>
|
|
196
|
+
|
|
197
|
+
<!-- Content Area -->
|
|
198
|
+
<main class="content">
|
|
199
|
+
<div class="content-inner">
|
|
200
|
+
<h1>Configuration Guide</h1>
|
|
201
|
+
<p>This guide explains how @knowcode/doc-builder handles configuration files and settings.</p>
|
|
202
|
+
<h2><i style="font-size: 1.2em" class="ph ph-push-pin" aria-label="pin"></i> Config File Location</h2>
|
|
203
|
+
<p>The configuration file is located at the root of your project:</p>
|
|
204
|
+
<pre><code>your-project/
|
|
205
|
+
├── docs/ # Your markdown files
|
|
206
|
+
├── doc-builder.config.js # Configuration file
|
|
207
|
+
├── package.json
|
|
208
|
+
└── README.md
|
|
209
|
+
</code></pre>
|
|
210
|
+
<h2><i style="font-size: 1.2em" class="ph ph-arrows-clockwise" aria-label="refresh"></i> Automatic Configuration Management</h2>
|
|
211
|
+
<h3>Config File Creation</h3>
|
|
212
|
+
<p>When you run any doc-builder command, the system automatically:</p>
|
|
213
|
+
<ol>
|
|
214
|
+
<li><strong>Checks for existing config</strong> - Looks for <code>doc-builder.config.js</code></li>
|
|
215
|
+
<li><strong>Creates if missing</strong> - Generates a complete config file with all default settings</li>
|
|
216
|
+
<li><strong>Preserves customizations</strong> - Your existing settings are never overwritten</li>
|
|
217
|
+
</ol>
|
|
218
|
+
<h3>Auto-Update on Version Upgrades</h3>
|
|
219
|
+
<p>When you upgrade to a newer version of doc-builder:</p>
|
|
220
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
221
|
+
</code></pre>
|
|
222
|
+
<p>The system automatically:</p>
|
|
223
|
+
<ul>
|
|
224
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Detects version changes</strong> using semantic versioning</li>
|
|
225
|
+
<li><i style="font-size: 1.2em" class="ph ph-arrows-clockwise" aria-label="refresh"></i> <strong>Migrates your config</strong> by adding new default options</li>
|
|
226
|
+
<li><i style="font-size: 1.2em" class="ph ph-floppy-disk" aria-label="save"></i> <strong>Creates backups</strong> before making changes (e.g., <code>doc-builder.config.js.backup.1234567890</code>)</li>
|
|
227
|
+
<li><i style="font-size: 1.2em" class="ph ph-sparkle" aria-label="special"></i> <strong>Logs new features</strong> that were added to your configuration</li>
|
|
228
|
+
</ul>
|
|
229
|
+
<h2><i style="font-size: 1.2em" class="ph ph-clipboard-text" aria-label="clipboard"></i> Default Configuration Structure</h2>
|
|
230
|
+
<p>Here's what gets created automatically:</p>
|
|
231
|
+
<pre><code class="language-javascript">module.exports = {
|
|
232
|
+
"configVersion": "1.9.7",
|
|
233
|
+
"siteName": "Documentation",
|
|
234
|
+
"siteDescription": "Documentation site built with @knowcode/doc-builder",
|
|
235
|
+
"docsDir": "docs",
|
|
236
|
+
"outputDir": "html",
|
|
237
|
+
"favicon": "✨",
|
|
238
|
+
|
|
239
|
+
"features": {
|
|
240
|
+
"authentication": false,
|
|
241
|
+
"changelog": true,
|
|
242
|
+
"mermaid": true,
|
|
243
|
+
"mermaidEnhanced": true,
|
|
244
|
+
"tooltips": true,
|
|
245
|
+
"search": false,
|
|
246
|
+
"darkMode": true,
|
|
247
|
+
"phosphorIcons": true,
|
|
248
|
+
"phosphorWeight": "regular",
|
|
249
|
+
"phosphorSize": "1.2em",
|
|
250
|
+
"normalizeTitle": true,
|
|
251
|
+
"showPdfDownload": true,
|
|
252
|
+
"menuDefaultOpen": true,
|
|
253
|
+
"attachments": true,
|
|
254
|
+
"dynamicNavIcons": true,
|
|
255
|
+
"subtleColors": true
|
|
256
|
+
},
|
|
257
|
+
|
|
258
|
+
"auth": {
|
|
259
|
+
"supabaseUrl": "",
|
|
260
|
+
"supabaseAnonKey": ""
|
|
261
|
+
},
|
|
262
|
+
|
|
263
|
+
"changelog": {
|
|
264
|
+
"daysBack": 14,
|
|
265
|
+
"enabled": true
|
|
266
|
+
},
|
|
267
|
+
|
|
268
|
+
"folderOrder": [],
|
|
269
|
+
"folderDescriptions": {},
|
|
270
|
+
"folderIcons": {},
|
|
271
|
+
|
|
272
|
+
"deployment": {
|
|
273
|
+
"platform": "vercel",
|
|
274
|
+
"outputDirectory": "html"
|
|
275
|
+
},
|
|
276
|
+
|
|
277
|
+
"seo": {
|
|
278
|
+
"enabled": true,
|
|
279
|
+
"siteUrl": "",
|
|
280
|
+
"author": "",
|
|
281
|
+
"twitterHandle": "",
|
|
282
|
+
"language": "en-US",
|
|
283
|
+
"keywords": [],
|
|
284
|
+
"titleTemplate": "{pageTitle} | {siteName}",
|
|
285
|
+
"autoKeywords": true,
|
|
286
|
+
"keywordLimit": 7,
|
|
287
|
+
"descriptionFallback": "smart",
|
|
288
|
+
"organization": {
|
|
289
|
+
"name": "",
|
|
290
|
+
"url": "",
|
|
291
|
+
"logo": ""
|
|
292
|
+
},
|
|
293
|
+
"ogImage": "",
|
|
294
|
+
"generateSitemap": true,
|
|
295
|
+
"generateRobotsTxt": true,
|
|
296
|
+
"customMetaTags": []
|
|
297
|
+
},
|
|
298
|
+
|
|
299
|
+
"attachmentTypes": [
|
|
300
|
+
".pdf", ".doc", ".docx", ".xls", ".xlsx", ".csv",
|
|
301
|
+
".ppt", ".pptx", ".txt", ".rtf", ".html", ".htm",
|
|
302
|
+
".zip", ".tar", ".gz", ".7z", ".rar",
|
|
303
|
+
".png", ".jpg", ".jpeg", ".gif", ".svg", ".webp",
|
|
304
|
+
".ico", ".bmp", ".json", ".xml", ".yaml", ".yml",
|
|
305
|
+
".toml", ".mp4", ".mp3", ".wav", ".avi", ".mov"
|
|
306
|
+
]
|
|
307
|
+
};
|
|
308
|
+
</code></pre>
|
|
309
|
+
<h2><i style="font-size: 1.2em" class="ph ph-faders" aria-label="controls"></i> Key Configuration Options</h2>
|
|
310
|
+
<h3>Site Identity</h3>
|
|
311
|
+
<ul>
|
|
312
|
+
<li><strong><code>siteName</code></strong> - Your documentation site name</li>
|
|
313
|
+
<li><strong><code>siteDescription</code></strong> - Brief description for SEO</li>
|
|
314
|
+
<li><strong><code>favicon</code></strong> - Site icon (emoji or image path)</li>
|
|
315
|
+
</ul>
|
|
316
|
+
<h3>Directory Structure</h3>
|
|
317
|
+
<ul>
|
|
318
|
+
<li><strong><code>docsDir</code></strong> - Source markdown directory (default: <code>docs</code>)</li>
|
|
319
|
+
<li><strong><code>outputDir</code></strong> - Generated HTML directory (default: <code>html</code>)</li>
|
|
320
|
+
</ul>
|
|
321
|
+
<h3>Features Toggle</h3>
|
|
322
|
+
<ul>
|
|
323
|
+
<li><strong><code>dynamicNavIcons</code></strong> - Status-based navigation icons</li>
|
|
324
|
+
<li><strong><code>subtleColors</code></strong> - Colored status indicators</li>
|
|
325
|
+
<li><strong><code>darkMode</code></strong> - Theme switching support</li>
|
|
326
|
+
<li><strong><code>mermaid</code></strong> - Diagram rendering</li>
|
|
327
|
+
<li><strong><code>mermaidEnhanced</code></strong> - Enhanced diagram styling with rounded corners (v1.9.18+)</li>
|
|
328
|
+
<li><strong><code>authentication</code></strong> - Private content protection</li>
|
|
329
|
+
</ul>
|
|
330
|
+
<h3>Advanced Settings</h3>
|
|
331
|
+
<ul>
|
|
332
|
+
<li><strong><code>phosphorWeight</code></strong> - Icon thickness (<code>thin</code>, <code>light</code>, <code>regular</code>, <code>bold</code>, <code>fill</code>)</li>
|
|
333
|
+
<li><strong><code>phosphorSize</code></strong> - Icon size relative to text</li>
|
|
334
|
+
<li><strong><code>attachmentTypes</code></strong> - File types to copy during build</li>
|
|
335
|
+
</ul>
|
|
336
|
+
<h2><i style="font-size: 1.2em" class="ph ph-chart-bar" aria-label="chart"></i> Mermaid Diagram Configuration</h2>
|
|
337
|
+
<h3>Enhanced Styling (v1.9.18+)</h3>
|
|
338
|
+
<p>The new <code>mermaidEnhanced</code> feature provides professional diagram styling:</p>
|
|
339
|
+
<pre><code class="language-javascript">features: {
|
|
340
|
+
mermaid: true, // Enable Mermaid diagrams
|
|
341
|
+
mermaidEnhanced: true, // Enhanced styling with rounded corners
|
|
342
|
+
}
|
|
343
|
+
</code></pre>
|
|
344
|
+
<p><strong>Enhanced Features:</strong></p>
|
|
345
|
+
<ul>
|
|
346
|
+
<li><i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> <strong>Rounded corners</strong> (8px radius) on all diagram shapes</li>
|
|
347
|
+
<li><i style="font-size: 1.2em" class="ph ph-palette" aria-label="design"></i> <strong>Notion-inspired color palette</strong> for better visual integration</li>
|
|
348
|
+
<li><i style="font-size: 1.2em" class="ph ph-moon" aria-label="night"></i> <strong>Automatic theme support</strong> for light and dark modes</li>
|
|
349
|
+
<li><i style="font-size: 1.2em" class="ph ph-sparkle" aria-label="special"></i> <strong>Improved spacing</strong> and typography consistency</li>
|
|
350
|
+
</ul>
|
|
351
|
+
<p><strong>To disable enhanced styling:</strong></p>
|
|
352
|
+
<pre><code class="language-javascript">features: {
|
|
353
|
+
mermaid: true,
|
|
354
|
+
mermaidEnhanced: false, // Use default Mermaid styling
|
|
355
|
+
}
|
|
356
|
+
</code></pre>
|
|
357
|
+
<h2><i style="font-size: 1.2em" class="ph ph-rocket-launch" aria-label="launch"></i> No Manual Editing Required</h2>
|
|
358
|
+
<p>The beauty of this system is that you typically <strong>never need to manually edit</strong> the config file:</p>
|
|
359
|
+
<ol>
|
|
360
|
+
<li><strong>Default creation</strong> - Perfect defaults for most use cases</li>
|
|
361
|
+
<li><strong>CLI overrides</strong> - Command-line options override config when needed</li>
|
|
362
|
+
<li><strong>Automatic updates</strong> - New features added seamlessly</li>
|
|
363
|
+
<li><strong>Smart detection</strong> - Private directories auto-enable authentication</li>
|
|
364
|
+
</ol>
|
|
365
|
+
<h2><i style="font-size: 1.2em" class="ph ph-magnifying-glass" aria-label="search"></i> Migration Logs</h2>
|
|
366
|
+
<p>When your config is updated, you'll see helpful output:</p>
|
|
367
|
+
<pre><code class="language-bash">🔄 Migrating config from 1.9.6 to 1.9.7
|
|
368
|
+
✨ Added new features: Dynamic navigation icons, Subtle status colors
|
|
369
|
+
💾 Backed up existing config to doc-builder.config.js.backup.1234567890
|
|
370
|
+
✅ Updated config file: doc-builder.config.js
|
|
371
|
+
</code></pre>
|
|
372
|
+
<h2>🛟 Recovery & Rollback</h2>
|
|
373
|
+
<p>If something goes wrong:</p>
|
|
374
|
+
<ol>
|
|
375
|
+
<li><strong>Check backups</strong> - Look for <code>.backup</code> files in your project root</li>
|
|
376
|
+
<li><strong>Restore manually</strong> - Copy backup content back to <code>doc-builder.config.js</code></li>
|
|
377
|
+
<li><strong>Delete and regenerate</strong> - Remove config file and run any command to recreate</li>
|
|
378
|
+
</ol>
|
|
379
|
+
<h2><i style="font-size: 1.2em" class="ph ph-lightbulb" aria-label="idea"></i> Best Practices</h2>
|
|
380
|
+
<ul>
|
|
381
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Commit config files</strong> - Include <code>doc-builder.config.js</code> in version control</li>
|
|
382
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Keep backups</strong> - Don't delete <code>.backup</code> files immediately</li>
|
|
383
|
+
<li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Use CLI commands</strong> - Let the tool manage configuration</li>
|
|
384
|
+
<li><i style="font-size: 1.2em" class="ph ph-x-circle" aria-label="error"></i> <strong>Avoid manual editing</strong> - Unless you need very specific customizations</li>
|
|
385
|
+
</ul>
|
|
386
|
+
<p>This automatic configuration system ensures you always have the latest features while maintaining your customizations!</p>
|
|
387
|
+
|
|
388
|
+
</div>
|
|
389
|
+
</main>
|
|
390
|
+
</div>
|
|
391
|
+
|
|
392
|
+
<!-- Scripts -->
|
|
393
|
+
<script>
|
|
394
|
+
// Pass configuration to frontend
|
|
395
|
+
window.docBuilderConfig = {
|
|
396
|
+
features: {
|
|
397
|
+
showPdfDownload: true,
|
|
398
|
+
menuDefaultOpen: false,
|
|
399
|
+
mermaidEnhanced: true
|
|
400
|
+
}
|
|
401
|
+
};
|
|
402
|
+
</script>
|
|
403
|
+
<script src="/js/main.js"></script>
|
|
404
|
+
|
|
405
|
+
</body>
|
|
406
|
+
</html>
|