@knowcode/doc-builder 1.5.21 → 1.5.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/settings.local.json +2 -1
- package/CLAUDE.md +7 -301
- package/CONTRIBUTING.md +148 -0
- package/GITHUB_SETUP.md +203 -0
- package/LICENSE +21 -0
- package/README.md +8 -9
- package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
- package/assets/css/notion-style.css +3 -3
- package/doc-builder.config.js +1 -1
- package/html/README.html +37 -41
- package/html/css/notion-style.css +3 -3
- package/html/documentation-index.html +17 -9
- package/html/guides/authentication-guide.html +19 -11
- package/html/guides/claude-workflow-guide.html +17 -9
- package/html/guides/documentation-standards.html +17 -9
- package/html/guides/google-site-verification-guide.html +13 -4
- package/html/guides/phosphor-icons-guide.html +17 -9
- package/html/guides/seo-guide.html +17 -9
- package/html/guides/seo-optimization-guide.html +13 -5
- package/html/guides/troubleshooting-guide.html +17 -9
- package/html/guides/windows-setup-guide.html +17 -9
- package/html/index.html +37 -41
- package/html/launch/README.html +277 -0
- package/html/launch/bubble-plugin-specification.html +913 -0
- package/html/launch/go-to-market-strategy.html +643 -0
- package/html/launch/launch-announcements.html +573 -0
- package/html/sitemap.xml +41 -17
- package/html/vercel-cli-setup-guide.html +17 -9
- package/html/vercel-first-time-setup-guide.html +57 -34
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
Beautiful documentation with the least effort possible. A zero-configuration documentation builder that transforms markdown files into stunning static sites.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/@knowcode/doc-builder)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
[](https://github.com/wapdat/doc-builder/stargazers)
|
|
8
|
+
[](https://github.com/wapdat/doc-builder/issues)
|
|
9
|
+
|
|
5
10
|
<div align="center">
|
|
6
11
|
|
|
7
12
|
🔗 **[View Live Example](https://doc-builder-delta.vercel.app)** | 📦 **[NPM Package](https://www.npmjs.com/package/@knowcode/doc-builder)** | 📚 **[Documentation](https://doc-builder-delta.vercel.app)**
|
|
@@ -59,7 +64,6 @@ This aligns perfectly with our mission: beautiful documentation should be access
|
|
|
59
64
|
- 🚀 **Zero Configuration** - Works out of the box
|
|
60
65
|
- 📝 **Markdown Support** - Full GitHub Flavored Markdown
|
|
61
66
|
- 🎨 **Beautiful Theme** - Notion-inspired design
|
|
62
|
-
- 🔄 **Live Reload** - Hot reloading dev server
|
|
63
67
|
- 📦 **Self-Contained** - No setup required
|
|
64
68
|
- 🤖 **Claude Code Ready** - AI-optimized workflows
|
|
65
69
|
|
|
@@ -142,9 +146,6 @@ npx @knowcode/doc-builder@latest deploy
|
|
|
142
146
|
# Build static HTML
|
|
143
147
|
npx @knowcode/doc-builder@latest build
|
|
144
148
|
|
|
145
|
-
# Development server
|
|
146
|
-
npx @knowcode/doc-builder@latest dev
|
|
147
|
-
|
|
148
149
|
# Show help
|
|
149
150
|
npx @knowcode/doc-builder@latest
|
|
150
151
|
```
|
|
@@ -161,7 +162,6 @@ npm install --save-dev @knowcode/doc-builder@latest
|
|
|
161
162
|
# Use shorter commands
|
|
162
163
|
doc-builder deploy
|
|
163
164
|
doc-builder build
|
|
164
|
-
doc-builder dev
|
|
165
165
|
doc-builder --help
|
|
166
166
|
```
|
|
167
167
|
*Better for regular use & offline access*
|
|
@@ -201,8 +201,8 @@ module.exports = {
|
|
|
201
201
|
outputDir: 'html',
|
|
202
202
|
|
|
203
203
|
// Site info
|
|
204
|
-
siteName: '
|
|
205
|
-
siteDescription: '
|
|
204
|
+
siteName: '@knowcode/doc-builder',
|
|
205
|
+
siteDescription: 'Transform markdown into beautiful documentation',
|
|
206
206
|
|
|
207
207
|
// Production URL (optional)
|
|
208
208
|
productionUrl: 'https://my-docs.vercel.app', // Custom URL to display after deployment
|
|
@@ -233,7 +233,6 @@ module.exports = {
|
|
|
233
233
|
| Command | Purpose |
|
|
234
234
|
|---------|---------|
|
|
235
235
|
| `build` | Generate static HTML |
|
|
236
|
-
| `dev` | Start dev server |
|
|
237
236
|
| `deploy` | Deploy to Vercel |
|
|
238
237
|
| `init` | Initialize project |
|
|
239
238
|
|
|
@@ -555,7 +554,7 @@ MIT License - See [LICENSE](LICENSE) file for details
|
|
|
555
554
|
|
|
556
555
|
### Quick Links
|
|
557
556
|
|
|
558
|
-
[**NPM Package**](https://www.npmjs.com/package/@knowcode/doc-builder) | [**Live Demo**](https://doc-builder-delta.vercel.app) | [**Report Issues**](https://github.com/
|
|
557
|
+
[**NPM Package**](https://www.npmjs.com/package/@knowcode/doc-builder) | [**Live Demo**](https://doc-builder-delta.vercel.app) | [**Report Issues**](https://github.com/wapdat/doc-builder/issues) | [**Changelog**](CHANGELOG.md)
|
|
559
558
|
|
|
560
559
|
Made with ❤️ by the @knowcode team
|
|
561
560
|
|
|
Binary file
|
|
@@ -1061,13 +1061,13 @@ tr:hover {
|
|
|
1061
1061
|
padding: var(--space-4);
|
|
1062
1062
|
border-radius: var(--radius-lg);
|
|
1063
1063
|
overflow-x: auto;
|
|
1064
|
-
margin: var(--space-
|
|
1064
|
+
margin: var(--space-2) 0;
|
|
1065
1065
|
}
|
|
1066
1066
|
|
|
1067
1067
|
/* Mermaid Full Screen Viewer */
|
|
1068
1068
|
.mermaid-container {
|
|
1069
1069
|
position: relative;
|
|
1070
|
-
margin: var(--space-
|
|
1070
|
+
margin: var(--space-3) 0;
|
|
1071
1071
|
border: 1px solid var(--color-border-default);
|
|
1072
1072
|
border-radius: var(--radius-lg);
|
|
1073
1073
|
overflow: hidden;
|
|
@@ -1129,7 +1129,7 @@ tr:hover {
|
|
|
1129
1129
|
}
|
|
1130
1130
|
|
|
1131
1131
|
.mermaid-wrapper {
|
|
1132
|
-
padding: var(--space-
|
|
1132
|
+
padding: var(--space-3);
|
|
1133
1133
|
overflow: auto;
|
|
1134
1134
|
max-height: 600px;
|
|
1135
1135
|
}
|
package/doc-builder.config.js
CHANGED
package/html/README.html
CHANGED
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T19:23:11.898Z",
|
|
66
|
+
"dateModified": "2025-07-22T19:23:11.898Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.22">Last updated: Jul 22, 2025, 07:23 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
149
149
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
150
150
|
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
151
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
151
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
152
152
|
<div class="nav-section" data-level="1">
|
|
153
153
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
154
154
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -163,6 +163,15 @@
|
|
|
163
163
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
164
164
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
165
165
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
166
|
+
<div class="nav-section" data-level="1">
|
|
167
|
+
<a class="nav-title collapsible expanded" href="/launch/README.html" data-target="nav-launch-1" >
|
|
168
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
169
|
+
</a>
|
|
170
|
+
<div class="nav-content" id="nav-launch-1">
|
|
171
|
+
<a href="/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="fas fa-file-alt"></i> Launch Overview</a>
|
|
172
|
+
<a href="/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="fas fa-file-alt"></i> Bubble Plugin Specification</a>
|
|
173
|
+
<a href="/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
174
|
+
<a href="/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a></div></div>
|
|
166
175
|
</nav>
|
|
167
176
|
<div class="resize-handle"></div>
|
|
168
177
|
</aside>
|
|
@@ -180,7 +189,7 @@
|
|
|
180
189
|
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h3>
|
|
181
190
|
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
182
191
|
</code></pre>
|
|
183
|
-
<p><a href="https://doc-builder-delta.vercel.app"><strong>
|
|
192
|
+
<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>
|
|
184
193
|
</div>
|
|
185
194
|
|
|
186
195
|
<hr>
|
|
@@ -253,66 +262,53 @@
|
|
|
253
262
|
<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
|
|
254
263
|
<table>
|
|
255
264
|
<tr>
|
|
256
|
-
<td width="
|
|
265
|
+
<td width="50%">
|
|
257
266
|
|
|
258
|
-
<h3>1️⃣
|
|
267
|
+
<h3>1️⃣ Setup</h3>
|
|
259
268
|
<pre><code class="language-bash">npx @knowcode/doc-builder@latest init
|
|
260
269
|
</code></pre>
|
|
261
|
-
<p><em>Create project structure</em></p>
|
|
270
|
+
<p><em>Create project structure and configure doc-builder</em></p>
|
|
262
271
|
</td>
|
|
263
|
-
<td width="
|
|
264
|
-
|
|
265
|
-
<h3>2️⃣ Write Docs</h3>
|
|
266
|
-
<pre><code class="language-markdown"># Getting Started
|
|
267
|
-
Welcome to our docs!
|
|
268
|
-
|
|
269
|
-
## Features
|
|
270
|
-
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
|
|
271
|
-
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature two
|
|
272
|
-
</code></pre>
|
|
273
|
-
<p><em>Use markdown files</em></p>
|
|
274
|
-
</td>
|
|
275
|
-
<td width="25%">
|
|
276
|
-
|
|
277
|
-
<h3>3️⃣ Preview</h3>
|
|
278
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder@latest dev
|
|
279
|
-
</code></pre>
|
|
280
|
-
<p><em>Live development server</em></p>
|
|
281
|
-
</td>
|
|
282
|
-
<td width="25%">
|
|
272
|
+
<td width="50%">
|
|
283
273
|
|
|
284
|
-
<h3>
|
|
274
|
+
<h3>2️⃣ Deploy</h3>
|
|
285
275
|
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
286
276
|
</code></pre>
|
|
287
|
-
<p><em>
|
|
277
|
+
<p><em>Build your markdown files and deploy to production</em></p>
|
|
288
278
|
</td>
|
|
289
279
|
</tr>
|
|
290
280
|
</table>
|
|
291
281
|
|
|
292
282
|
<h2><i class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
|
|
283
|
+
<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>
|
|
293
284
|
<table>
|
|
294
285
|
<tr>
|
|
295
286
|
<td width="50%">
|
|
296
287
|
|
|
297
|
-
<h3>Basic Config</h3>
|
|
298
|
-
<pre><code class="language-javascript"
|
|
299
|
-
|
|
300
|
-
|
|
288
|
+
<h3>Basic Config (Reference Only)</h3>
|
|
289
|
+
<pre><code class="language-javascript">// doc-builder.config.js
|
|
290
|
+
// This file is auto-generated and managed by the CLI
|
|
291
|
+
module.exports = {
|
|
292
|
+
siteName: '@knowcode/doc-builder',
|
|
293
|
+
siteDescription: 'Transform markdown into beautiful documentation',
|
|
301
294
|
docsDir: 'docs',
|
|
302
295
|
outputDir: 'html'
|
|
303
296
|
};
|
|
304
297
|
</code></pre>
|
|
298
|
+
<p><em>The CLI creates and updates this for you</em></p>
|
|
305
299
|
</td>
|
|
306
300
|
<td width="50%">
|
|
307
301
|
|
|
308
|
-
<h3>Advanced Features</h3>
|
|
309
|
-
<pre><code class="language-javascript"
|
|
302
|
+
<h3>Advanced Features (Reference Only)</h3>
|
|
303
|
+
<pre><code class="language-javascript">// Also managed via CLI commands
|
|
304
|
+
features: {
|
|
310
305
|
mermaid: true, // Diagrams
|
|
311
306
|
darkMode: true, // Theme toggle
|
|
312
307
|
authentication: true, // Password
|
|
313
308
|
changelog: true // Auto-generate
|
|
314
309
|
}
|
|
315
310
|
</code></pre>
|
|
311
|
+
<p><em>Use <code>init</code> or <code>deploy</code> commands to configure</em></p>
|
|
316
312
|
</td>
|
|
317
313
|
</tr>
|
|
318
314
|
</table>
|
|
@@ -340,7 +336,7 @@ Welcome to our docs!
|
|
|
340
336
|
const docBuilder = require('@knowcode/doc-builder');
|
|
341
337
|
|
|
342
338
|
docBuilder.build({
|
|
343
|
-
siteName: '
|
|
339
|
+
siteName: '@knowcode/doc-builder',
|
|
344
340
|
features: { darkMode: true }
|
|
345
341
|
});
|
|
346
342
|
</code></pre>
|
|
@@ -387,7 +383,7 @@ docBuilder.build({
|
|
|
387
383
|
<td width="50%">
|
|
388
384
|
|
|
389
385
|
<h3>Contributing</h3>
|
|
390
|
-
<p>We welcome contributions! Check our <a href="https://github.com/
|
|
386
|
+
<p>We welcome contributions! Check our <a href="https://github.com/wapdat/doc-builder">contribution guide</a> to get started.</p>
|
|
391
387
|
<p><strong>Ways to help:</strong></p>
|
|
392
388
|
<ul>
|
|
393
389
|
<li><i class="ph ph-bug" aria-label="bug"></i> Report bugs</li>
|
|
@@ -403,9 +399,9 @@ docBuilder.build({
|
|
|
403
399
|
<p><strong>Connect with us:</strong></p>
|
|
404
400
|
<ul>
|
|
405
401
|
<li><i class="ph ph-package" aria-label="package"></i> <a href="https://www.npmjs.com/package/@knowcode/doc-builder">NPM Package</a></li>
|
|
406
|
-
<li>🐙 <a href="https://github.com/
|
|
402
|
+
<li>🐙 <a href="https://github.com/wapdat/doc-builder">GitHub Repo</a></li>
|
|
407
403
|
<li>🌐 <a href="https://knowcode.com">Website</a></li>
|
|
408
|
-
<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/
|
|
404
|
+
<li><i class="ph ph-chat-circle" aria-label="chat"></i> <a href="https://github.com/wapdat/doc-builder/discussions">Discussions</a></li>
|
|
409
405
|
</ul>
|
|
410
406
|
</td>
|
|
411
407
|
</tr>
|
|
@@ -416,7 +412,7 @@ docBuilder.build({
|
|
|
416
412
|
|
|
417
413
|
<h3><i class="ph ph-note-pencil" aria-label="edit"></i> License: MIT © KnowCode</h3>
|
|
418
414
|
<p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
|
|
419
|
-
<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>
|
|
415
|
+
<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>
|
|
420
416
|
</div>
|
|
421
417
|
|
|
422
418
|
</div>
|
|
@@ -1061,13 +1061,13 @@ tr:hover {
|
|
|
1061
1061
|
padding: var(--space-4);
|
|
1062
1062
|
border-radius: var(--radius-lg);
|
|
1063
1063
|
overflow-x: auto;
|
|
1064
|
-
margin: var(--space-
|
|
1064
|
+
margin: var(--space-2) 0;
|
|
1065
1065
|
}
|
|
1066
1066
|
|
|
1067
1067
|
/* Mermaid Full Screen Viewer */
|
|
1068
1068
|
.mermaid-container {
|
|
1069
1069
|
position: relative;
|
|
1070
|
-
margin: var(--space-
|
|
1070
|
+
margin: var(--space-3) 0;
|
|
1071
1071
|
border: 1px solid var(--color-border-default);
|
|
1072
1072
|
border-radius: var(--radius-lg);
|
|
1073
1073
|
overflow: hidden;
|
|
@@ -1129,7 +1129,7 @@ tr:hover {
|
|
|
1129
1129
|
}
|
|
1130
1130
|
|
|
1131
1131
|
.mermaid-wrapper {
|
|
1132
|
-
padding: var(--space-
|
|
1132
|
+
padding: var(--space-3);
|
|
1133
1133
|
overflow: auto;
|
|
1134
1134
|
max-height: 600px;
|
|
1135
1135
|
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
6
|
+
<meta name="description" content="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.">
|
|
7
7
|
<title>Documentation Index | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/documentation-index.html">
|
|
17
17
|
<meta property="og:title" content="Documentation Index | Doc Builder">
|
|
18
|
-
<meta property="og:description" content="
|
|
18
|
+
<meta property="og:description" content="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
27
|
<meta name="twitter:title" content="Documentation Index | Doc Builder">
|
|
28
|
-
<meta name="twitter:description" content="
|
|
28
|
+
<meta name="twitter:description" content="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"@context": "https://schema.org",
|
|
53
53
|
"@type": "TechArticle",
|
|
54
54
|
"headline": "Documentation Index",
|
|
55
|
-
"description": "
|
|
55
|
+
"description": "This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.",
|
|
56
56
|
"author": {
|
|
57
57
|
"@type": "Person",
|
|
58
58
|
"name": "Lindsay Smith"
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T19:23:11.910Z",
|
|
66
|
+
"dateModified": "2025-07-22T19:23:11.910Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
|
|
97
97
|
<div class="header-actions">
|
|
98
98
|
<div class="deployment-info">
|
|
99
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
99
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.22">Last updated: Jul 22, 2025, 07:23 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
149
149
|
<a href="/documentation-index.html" class="nav-item active" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
150
150
|
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
151
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
151
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
152
152
|
<div class="nav-section" data-level="1">
|
|
153
153
|
<a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
|
|
154
154
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -163,6 +163,15 @@
|
|
|
163
163
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
164
164
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
165
165
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
166
|
+
<div class="nav-section" data-level="1">
|
|
167
|
+
<a class="nav-title collapsible" href="/launch/README.html" data-target="nav-launch-1" >
|
|
168
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
169
|
+
</a>
|
|
170
|
+
<div class="nav-content collapsed" id="nav-launch-1">
|
|
171
|
+
<a href="/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="fas fa-file-alt"></i> Launch Overview</a>
|
|
172
|
+
<a href="/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="fas fa-file-alt"></i> Bubble Plugin Specification</a>
|
|
173
|
+
<a href="/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
174
|
+
<a href="/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a></div></div>
|
|
166
175
|
</nav>
|
|
167
176
|
<div class="resize-handle"></div>
|
|
168
177
|
</aside>
|
|
@@ -171,7 +180,6 @@
|
|
|
171
180
|
<main class="content">
|
|
172
181
|
<div class="content-inner">
|
|
173
182
|
<h1>Documentation Index</h1>
|
|
174
|
-
<p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
|
|
175
183
|
<h2>Overview</h2>
|
|
176
184
|
<p>This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.</p>
|
|
177
185
|
<h2>Directory Structure</h2>
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
6
|
+
<meta name="description" content="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...">
|
|
7
7
|
<title>Authentication Guide for @knowcode/doc-builder | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/authentication-guide.html">
|
|
17
17
|
<meta property="og:title" content="Authentication Guide for @knowcode/doc-builder | Doc Builder">
|
|
18
|
-
<meta property="og:description" content="
|
|
18
|
+
<meta property="og:description" content="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
27
|
<meta name="twitter:title" content="Authentication Guide for @knowcode/doc-builder | Doc Builder">
|
|
28
|
-
<meta name="twitter:description" content="
|
|
28
|
+
<meta name="twitter:description" content="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"@context": "https://schema.org",
|
|
53
53
|
"@type": "TechArticle",
|
|
54
54
|
"headline": "Authentication Guide for @knowcode/doc-builder",
|
|
55
|
-
"description": "
|
|
55
|
+
"description": "This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic...",
|
|
56
56
|
"author": {
|
|
57
57
|
"@type": "Person",
|
|
58
58
|
"name": "Lindsay Smith"
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T19:23:11.914Z",
|
|
66
|
+
"dateModified": "2025-07-22T19:23:11.914Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
|
|
103
103
|
<div class="header-actions">
|
|
104
104
|
<div class="deployment-info">
|
|
105
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.22">Last updated: Jul 22, 2025, 07:23 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
155
155
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
156
156
|
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
157
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
157
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
158
158
|
<div class="nav-section" data-level="1">
|
|
159
159
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
160
160
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -169,6 +169,15 @@
|
|
|
169
169
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
170
170
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
171
171
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
172
|
+
<div class="nav-section" data-level="1">
|
|
173
|
+
<a class="nav-title collapsible" href="/launch/README.html" data-target="nav-launch-1" >
|
|
174
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
175
|
+
</a>
|
|
176
|
+
<div class="nav-content collapsed" id="nav-launch-1">
|
|
177
|
+
<a href="/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="fas fa-file-alt"></i> Launch Overview</a>
|
|
178
|
+
<a href="/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="fas fa-file-alt"></i> Bubble Plugin Specification</a>
|
|
179
|
+
<a href="/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
180
|
+
<a href="/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a></div></div>
|
|
172
181
|
</nav>
|
|
173
182
|
<div class="resize-handle"></div>
|
|
174
183
|
</aside>
|
|
@@ -177,7 +186,6 @@
|
|
|
177
186
|
<main class="content">
|
|
178
187
|
<div class="content-inner">
|
|
179
188
|
<h1>Authentication Guide for @knowcode/doc-builder</h1>
|
|
180
|
-
<p><strong>Generated</strong>: 2025-07-21 18:30 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
|
|
181
189
|
<h2>Overview</h2>
|
|
182
190
|
<p>This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic username/password access control.</p>
|
|
183
191
|
<h2>What is Authentication?</h2>
|
|
@@ -229,7 +237,7 @@
|
|
|
229
237
|
<h4>1. Configuration File</h4>
|
|
230
238
|
<p>Create <code>doc-builder.config.js</code> in your project root:</p>
|
|
231
239
|
<pre><code class="language-javascript">module.exports = {
|
|
232
|
-
siteName: '
|
|
240
|
+
siteName: '@knowcode/doc-builder',
|
|
233
241
|
siteDescription: 'Internal documentation portal',
|
|
234
242
|
|
|
235
243
|
features: {
|
|
@@ -395,7 +403,7 @@
|
|
|
395
403
|
<h3>Simple Protected Docs</h3>
|
|
396
404
|
<pre><code class="language-javascript">// doc-builder.config.js
|
|
397
405
|
module.exports = {
|
|
398
|
-
siteName: '
|
|
406
|
+
siteName: '@knowcode/doc-builder',
|
|
399
407
|
features: {
|
|
400
408
|
authentication: true
|
|
401
409
|
},
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="description" content="
|
|
6
|
+
<meta name="description" content="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it to...">
|
|
7
7
|
<title>Claude + CLAUDE.md Documentation Workflow Guide</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<meta property="og:type" content="article">
|
|
16
16
|
<meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html">
|
|
17
17
|
<meta property="og:title" content="Claude + CLAUDE.md Documentation Workflow Guide">
|
|
18
|
-
<meta property="og:description" content="
|
|
18
|
+
<meta property="og:description" content="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it to...">
|
|
19
19
|
<meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
20
20
|
<meta property="og:site_name" content="Doc Builder">
|
|
21
21
|
<meta property="og:locale" content="en_US">
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
<meta name="twitter:site" content="@planbbackups">
|
|
26
26
|
<meta name="twitter:creator" content="@planbbackups">
|
|
27
27
|
<meta name="twitter:title" content="Claude + CLAUDE.md Documentation Workflow Guide">
|
|
28
|
-
<meta name="twitter:description" content="
|
|
28
|
+
<meta name="twitter:description" content="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it to...">
|
|
29
29
|
<meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
|
|
30
30
|
|
|
31
31
|
<!-- Custom Meta Tags -->
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"@context": "https://schema.org",
|
|
53
53
|
"@type": "TechArticle",
|
|
54
54
|
"headline": "Claude + CLAUDE.md Documentation Workflow Guide",
|
|
55
|
-
"description": "
|
|
55
|
+
"description": "This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it to...",
|
|
56
56
|
"author": {
|
|
57
57
|
"@type": "Person",
|
|
58
58
|
"name": "Lindsay Smith"
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"name": "Knowcode Ltd",
|
|
63
63
|
"url": "https://knowcode.tech"
|
|
64
64
|
},
|
|
65
|
-
"datePublished": "2025-07-
|
|
66
|
-
"dateModified": "2025-07-
|
|
65
|
+
"datePublished": "2025-07-22T19:23:11.919Z",
|
|
66
|
+
"dateModified": "2025-07-22T19:23:11.919Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
|
|
103
103
|
<div class="header-actions">
|
|
104
104
|
<div class="deployment-info">
|
|
105
|
-
<span class="deployment-date" title="Built with doc-builder v1.5.
|
|
105
|
+
<span class="deployment-date" title="Built with doc-builder v1.5.22">Last updated: Jul 22, 2025, 07:23 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
<a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
|
|
155
155
|
<a href="/documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="fas fa-file-alt"></i> Documentation Index</a>
|
|
156
156
|
<a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
|
|
157
|
-
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the
|
|
157
|
+
<a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
|
|
158
158
|
<div class="nav-section" data-level="1">
|
|
159
159
|
<a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
|
|
160
160
|
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
|
|
@@ -169,6 +169,15 @@
|
|
|
169
169
|
<a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
|
|
170
170
|
<a href="/guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Troubleshooting Guide</a>
|
|
171
171
|
<a href="/guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
|
|
172
|
+
<div class="nav-section" data-level="1">
|
|
173
|
+
<a class="nav-title collapsible" href="/launch/README.html" data-target="nav-launch-1" >
|
|
174
|
+
<i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
|
|
175
|
+
</a>
|
|
176
|
+
<div class="nav-content collapsed" id="nav-launch-1">
|
|
177
|
+
<a href="/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="fas fa-file-alt"></i> Launch Overview</a>
|
|
178
|
+
<a href="/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="fas fa-file-alt"></i> Bubble Plugin Specification</a>
|
|
179
|
+
<a href="/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy & Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
|
|
180
|
+
<a href="/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a></div></div>
|
|
172
181
|
</nav>
|
|
173
182
|
<div class="resize-handle"></div>
|
|
174
183
|
</aside>
|
|
@@ -177,7 +186,6 @@
|
|
|
177
186
|
<main class="content">
|
|
178
187
|
<div class="content-inner">
|
|
179
188
|
<h1>Claude + CLAUDE.md Documentation Workflow Guide</h1>
|
|
180
|
-
<p><strong>Generated</strong>: 2025-07-21 10:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: <i class="ph ph-check-circle" aria-label="checked"></i></p>
|
|
181
189
|
<h2>Overview</h2>
|
|
182
190
|
<p>This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it to Vercel using the @knowcode/doc-builder tool.</p>
|
|
183
191
|
<h2>Workflow Overview</h2>
|