@knowcode/doc-builder 1.5.15 → 1.5.17
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/CHANGELOG.md +28 -0
- package/README.md +103 -35
- package/assets/css/notion-style.css +2 -0
- package/assets/js/main.js +0 -18
- package/cli.js +22 -22
- package/html/README.html +209 -95
- package/html/css/notion-style.css +21 -13
- package/html/documentation-index.html +5 -4
- package/html/guides/authentication-guide.html +10 -10
- package/html/guides/claude-workflow-guide.html +5 -10
- package/html/guides/documentation-standards.html +5 -5
- package/html/guides/google-site-verification-guide.html +5 -4
- package/html/guides/phosphor-icons-guide.html +5 -4
- package/html/guides/seo-guide.html +9 -8
- package/html/guides/seo-optimization-guide.html +5 -4
- package/html/guides/troubleshooting-guide.html +15 -15
- package/html/guides/windows-setup-guide.html +667 -0
- package/html/index.html +209 -95
- package/html/js/main.js +0 -18
- package/html/sitemap.xml +22 -16
- package/html/vercel-cli-setup-guide.html +7 -6
- package/html/vercel-first-time-setup-guide.html +7 -6
- package/lib/core-builder.js +5 -6
- package/lib/deploy.js +6 -6
- package/package.json +1 -1
- package/recordings/mh-ls-22jul.txt +2305 -0
- package/scripts/setup.js +3 -3
- package/Screenshot 2025-07-21 at 11.52.33.png +0 -0
- package/Screenshot 2025-07-21 at 12.14.39.png +0 -0
- package/Screenshot 2025-07-21 at 17.13.17.png +0 -0
- package/Screenshot 2025-07-21 at 17.16.15.png +0 -0
- package/Screenshot 2025-07-22 at 12.14.13.png +0 -0
package/html/README.html
CHANGED
|
@@ -3,11 +3,11 @@
|
|
|
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="<div align="center">">
|
|
7
7
|
<title>@knowcode/doc-builder | Doc Builder</title>
|
|
8
8
|
|
|
9
9
|
<meta name="author" content="Lindsay Smith">
|
|
10
|
-
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style,
|
|
10
|
+
<meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, width, table">
|
|
11
11
|
<meta name="robots" content="index, follow">
|
|
12
12
|
<link rel="canonical" href="https://doc-builder-delta.vercel.app/README.html">
|
|
13
13
|
|
|
@@ -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/README.html">
|
|
17
17
|
<meta property="og:title" content="@knowcode/doc-builder | Doc Builder">
|
|
18
|
-
<meta property="og:description" content=">
|
|
18
|
+
<meta property="og:description" content="<div align="center">">
|
|
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="@knowcode/doc-builder | Doc Builder">
|
|
28
|
-
<meta name="twitter:description" content=">
|
|
28
|
+
<meta name="twitter:description" content="<div align="center">">
|
|
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": "@knowcode/doc-builder",
|
|
55
|
-
"description": "
|
|
55
|
+
"description": "<div align=\"center\">",
|
|
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-22T15:31:48.134Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:31:48.134Z",
|
|
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.16">Last updated: Jul 22, 2025, 03:31 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -161,7 +161,8 @@
|
|
|
161
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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
162
162
|
<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="fas fa-file-alt"></i> Seo Guide</a>
|
|
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
|
-
<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
|
|
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
|
+
<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>
|
|
165
166
|
</nav>
|
|
166
167
|
<div class="resize-handle"></div>
|
|
167
168
|
</aside>
|
|
@@ -170,139 +171,252 @@
|
|
|
170
171
|
<main class="content">
|
|
171
172
|
<div class="content-inner">
|
|
172
173
|
<h1>@knowcode/doc-builder</h1>
|
|
174
|
+
<div align="center">
|
|
175
|
+
|
|
173
176
|
<blockquote>
|
|
174
177
|
<p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
|
|
175
178
|
</blockquote>
|
|
176
179
|
<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>
|
|
177
|
-
<
|
|
178
|
-
<
|
|
179
|
-
<pre><code class="language-bash"># Install globally
|
|
180
|
-
npm install -g @knowcode/doc-builder
|
|
181
|
-
|
|
182
|
-
# Or use with npx
|
|
183
|
-
npx @knowcode/doc-builder@latest deploy
|
|
180
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h3>
|
|
181
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
184
182
|
</code></pre>
|
|
183
|
+
<p><a href="https://doc-builder-delta.vercel.app"><strong>Live Demo</strong></a> | <a href="https://www.npmjs.com/package/@knowcode/doc-builder"><strong>NPM Package</strong></a> | <a href="https://github.com/knowcode/doc-builder"><strong>GitHub</strong></a></p>
|
|
184
|
+
</div>
|
|
185
|
+
|
|
186
|
+
<hr>
|
|
185
187
|
<h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
|
|
186
|
-
<
|
|
188
|
+
<table>
|
|
189
|
+
<tr>
|
|
190
|
+
<td width="50%">
|
|
191
|
+
|
|
192
|
+
<h3><i class="ph ph-palette" aria-label="design"></i> Design & UX</h3>
|
|
187
193
|
<ul>
|
|
188
|
-
<li><strong>Notion-inspired UI</strong> - Clean, modern interface
|
|
194
|
+
<li><strong>Notion-inspired UI</strong> - Clean, modern interface</li>
|
|
189
195
|
<li><strong>Dark mode support</strong> - Automatic theme switching</li>
|
|
190
|
-
<li><strong>Responsive layout</strong> - Perfect on
|
|
191
|
-
<li><strong>Syntax highlighting</strong> - Beautiful code blocks
|
|
196
|
+
<li><strong>Responsive layout</strong> - Perfect on any device</li>
|
|
197
|
+
<li><strong>Syntax highlighting</strong> - Beautiful code blocks</li>
|
|
192
198
|
</ul>
|
|
193
|
-
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i>
|
|
199
|
+
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Navigation</h3>
|
|
194
200
|
<ul>
|
|
195
201
|
<li><strong>Full-text search</strong> - Find anything instantly</li>
|
|
196
|
-
<li><strong>Smart navigation</strong> - Hierarchical
|
|
202
|
+
<li><strong>Smart navigation</strong> - Hierarchical structure</li>
|
|
197
203
|
<li><strong>Breadcrumbs</strong> - Always know where you are</li>
|
|
198
204
|
<li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
|
|
199
205
|
</ul>
|
|
200
|
-
|
|
201
|
-
<
|
|
202
|
-
|
|
203
|
-
<
|
|
204
|
-
<li><strong>Interactive tooltips</strong> - Document summaries on hover</li>
|
|
205
|
-
<li><strong>Version tracking</strong> - Know which version built your docs</li>
|
|
206
|
-
</ul>
|
|
207
|
-
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Easy Deployment</h3>
|
|
206
|
+
</td>
|
|
207
|
+
<td width="50%">
|
|
208
|
+
|
|
209
|
+
<h3><i class="ph ph-chart-bar" aria-label="chart"></i> Content Support</h3>
|
|
208
210
|
<ul>
|
|
209
|
-
<li><strong>
|
|
210
|
-
<li><strong>
|
|
211
|
-
<li><strong>
|
|
212
|
-
<li><strong>
|
|
211
|
+
<li><strong>Mermaid diagrams</strong> - Visual documentation</li>
|
|
212
|
+
<li><strong>GitHub markdown</strong> - Full GFM support</li>
|
|
213
|
+
<li><strong>Interactive tooltips</strong> - Document previews</li>
|
|
214
|
+
<li><strong>Version tracking</strong> - Build metadata</li>
|
|
213
215
|
</ul>
|
|
214
|
-
<
|
|
215
|
-
<p>Visit our <a href="https://www.npmjs.com/package/@knowcode/doc-builder">official documentation</a> for detailed guides and API reference.</p>
|
|
216
|
-
<h2><i class="ph ph-target" aria-label="goal"></i> Perfect For</h2>
|
|
216
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Deployment</h3>
|
|
217
217
|
<ul>
|
|
218
|
-
<li><strong>
|
|
219
|
-
<li><strong>
|
|
220
|
-
<li><strong>
|
|
221
|
-
<li><strong>
|
|
218
|
+
<li><strong>One-command deploy</strong> - Push to Vercel</li>
|
|
219
|
+
<li><strong>Static generation</strong> - Fast & secure</li>
|
|
220
|
+
<li><strong>Custom domains</strong> - Your brand</li>
|
|
221
|
+
<li><strong>Preview deploys</strong> - Test changes</li>
|
|
222
222
|
</ul>
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
</code></pre>
|
|
227
|
-
<h3>2. Write Your Documentation</h3>
|
|
228
|
-
<p>Create markdown files in your <code>docs</code> folder:</p>
|
|
229
|
-
<pre><code class="language-markdown"># Getting Started
|
|
223
|
+
</td>
|
|
224
|
+
</tr>
|
|
225
|
+
</table>
|
|
230
226
|
|
|
231
|
-
|
|
227
|
+
<h2><i class="ph ph-target" aria-label="goal"></i> Use Cases</h2>
|
|
228
|
+
<table>
|
|
229
|
+
<tr>
|
|
230
|
+
<td width="25%">
|
|
232
231
|
|
|
233
|
-
|
|
232
|
+
<h3>Open Source</h3>
|
|
233
|
+
<p>Beautiful docs for your community</p>
|
|
234
|
+
</td>
|
|
235
|
+
<td width="25%">
|
|
234
236
|
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
237
|
+
<h3>Technical Teams</h3>
|
|
238
|
+
<p>Internal docs developers love</p>
|
|
239
|
+
</td>
|
|
240
|
+
<td width="25%">
|
|
238
241
|
|
|
239
|
-
|
|
242
|
+
<h3>API Docs</h3>
|
|
243
|
+
<p>Clear, searchable references</p>
|
|
244
|
+
</td>
|
|
245
|
+
<td width="25%">
|
|
240
246
|
|
|
247
|
+
<h3>Knowledge Base</h3>
|
|
248
|
+
<p>Organize team knowledge</p>
|
|
249
|
+
</td>
|
|
250
|
+
</tr>
|
|
251
|
+
</table>
|
|
252
|
+
|
|
253
|
+
<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
|
|
254
|
+
<table>
|
|
255
|
+
<tr>
|
|
256
|
+
<td width="25%">
|
|
257
|
+
|
|
258
|
+
<h3>1️⃣ Initialize</h3>
|
|
259
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest init
|
|
260
|
+
</code></pre>
|
|
261
|
+
<p><em>Create project structure</em></p>
|
|
262
|
+
</td>
|
|
263
|
+
<td width="25%">
|
|
264
|
+
|
|
265
|
+
<h3>2️⃣ Write Docs</h3>
|
|
266
|
+
<pre><code class="language-markdown"># Getting Started
|
|
267
|
+
Welcome to our docs!
|
|
268
|
+
|
|
269
|
+
## Features
|
|
241
270
|
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
|
|
242
271
|
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature two
|
|
243
|
-
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature three
|
|
244
272
|
</code></pre>
|
|
245
|
-
<
|
|
246
|
-
|
|
247
|
-
|
|
273
|
+
<p><em>Use markdown files</em></p>
|
|
274
|
+
</td>
|
|
275
|
+
<td width="25%">
|
|
248
276
|
|
|
249
|
-
|
|
250
|
-
npx doc-builder
|
|
277
|
+
<h3>3️⃣ Preview</h3>
|
|
278
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest dev
|
|
251
279
|
</code></pre>
|
|
252
|
-
<
|
|
253
|
-
|
|
280
|
+
<p><em>Live development server</em></p>
|
|
281
|
+
</td>
|
|
282
|
+
<td width="25%">
|
|
283
|
+
|
|
284
|
+
<h3>4️⃣ Deploy</h3>
|
|
285
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
254
286
|
</code></pre>
|
|
255
|
-
<
|
|
256
|
-
|
|
287
|
+
<p><em>Push to production</em></p>
|
|
288
|
+
</td>
|
|
289
|
+
</tr>
|
|
290
|
+
</table>
|
|
291
|
+
|
|
292
|
+
<h2><i class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
|
|
293
|
+
<table>
|
|
294
|
+
<tr>
|
|
295
|
+
<td width="50%">
|
|
296
|
+
|
|
297
|
+
<h3>Basic Config</h3>
|
|
257
298
|
<pre><code class="language-javascript">module.exports = {
|
|
258
299
|
siteName: 'Your Amazing Docs',
|
|
259
|
-
siteDescription: '
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
darkMode: true,
|
|
263
|
-
authentication: false
|
|
264
|
-
}
|
|
300
|
+
siteDescription: 'Docs developers love',
|
|
301
|
+
docsDir: 'docs',
|
|
302
|
+
outputDir: 'html'
|
|
265
303
|
};
|
|
266
304
|
</code></pre>
|
|
267
|
-
|
|
268
|
-
<
|
|
305
|
+
</td>
|
|
306
|
+
<td width="50%">
|
|
307
|
+
|
|
308
|
+
<h3>Advanced Features</h3>
|
|
309
|
+
<pre><code class="language-javascript">features: {
|
|
310
|
+
mermaid: true, // Diagrams
|
|
311
|
+
darkMode: true, // Theme toggle
|
|
312
|
+
authentication: true, // Password
|
|
313
|
+
changelog: true // Auto-generate
|
|
314
|
+
}
|
|
315
|
+
</code></pre>
|
|
316
|
+
</td>
|
|
317
|
+
</tr>
|
|
318
|
+
</table>
|
|
319
|
+
|
|
320
|
+
<h2><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Examples</h2>
|
|
321
|
+
<table>
|
|
322
|
+
<tr>
|
|
323
|
+
<td width="50%">
|
|
324
|
+
|
|
325
|
+
<h3>Mermaid Diagrams</h3>
|
|
269
326
|
<div class="mermaid-wrapper">
|
|
270
|
-
<div class="mermaid-title">Diagram</div>
|
|
271
327
|
<div class="mermaid">graph LR
|
|
272
|
-
A[Write
|
|
328
|
+
A[Write] --> B[Build]
|
|
273
329
|
B --> C[Deploy]
|
|
274
|
-
C --> D[Share
|
|
330
|
+
C --> D[Share]
|
|
275
331
|
|
|
276
332
|
style A fill:#e1f5fe
|
|
277
333
|
style D fill:#c8e6c9</div>
|
|
278
334
|
</div>
|
|
279
|
-
|
|
280
|
-
<
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
335
|
+
</td>
|
|
336
|
+
<td width="50%">
|
|
337
|
+
|
|
338
|
+
<h3>Code with Syntax Highlighting</h3>
|
|
339
|
+
<pre><code class="language-javascript">// Beautiful code blocks
|
|
340
|
+
const docBuilder = require('@knowcode/doc-builder');
|
|
341
|
+
|
|
342
|
+
docBuilder.build({
|
|
343
|
+
siteName: 'My Docs',
|
|
344
|
+
features: { darkMode: true }
|
|
345
|
+
});
|
|
284
346
|
</code></pre>
|
|
285
|
-
|
|
347
|
+
</td>
|
|
348
|
+
</tr>
|
|
349
|
+
</table>
|
|
350
|
+
|
|
351
|
+
<h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why Choose doc-builder?</h2>
|
|
352
|
+
<table>
|
|
353
|
+
<tr>
|
|
354
|
+
<td width="33%">
|
|
355
|
+
|
|
356
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Performance</h3>
|
|
286
357
|
<ul>
|
|
287
|
-
<li><strong>
|
|
288
|
-
<li><strong>
|
|
289
|
-
<li><strong>SEO friendly</strong> - Optimized for search engines</li>
|
|
358
|
+
<li><strong>Lightning fast</strong> - Static generation</li>
|
|
359
|
+
<li><strong>SEO optimized</strong> - Search friendly</li>
|
|
290
360
|
<li><strong>Accessible</strong> - WCAG compliant</li>
|
|
291
|
-
|
|
361
|
+
</ul>
|
|
362
|
+
</td>
|
|
363
|
+
<td width="33%">
|
|
364
|
+
|
|
365
|
+
<h3><i class="ph ph-gear-six" aria-label="tools"></i> Developer Experience</h3>
|
|
366
|
+
<ul>
|
|
367
|
+
<li><strong>Zero config</strong> - Works instantly</li>
|
|
368
|
+
<li><strong>Version control</strong> - Git-friendly</li>
|
|
292
369
|
<li><strong>Open source</strong> - MIT licensed</li>
|
|
293
370
|
</ul>
|
|
294
|
-
|
|
295
|
-
<
|
|
296
|
-
|
|
297
|
-
<
|
|
371
|
+
</td>
|
|
372
|
+
<td width="33%">
|
|
373
|
+
|
|
374
|
+
<h3><i class="ph ph-money" aria-label="money"></i> Cost Effective</h3>
|
|
375
|
+
<ul>
|
|
376
|
+
<li><strong>Free hosting</strong> - Vercel free tier</li>
|
|
377
|
+
<li><strong>No vendor lock-in</strong> - Your content</li>
|
|
378
|
+
<li><strong>Export anywhere</strong> - Static HTML</li>
|
|
379
|
+
</ul>
|
|
380
|
+
</td>
|
|
381
|
+
</tr>
|
|
382
|
+
</table>
|
|
383
|
+
|
|
384
|
+
<h2><i class="ph ph-handshake" aria-label="partnership"></i> Get Involved</h2>
|
|
385
|
+
<table>
|
|
386
|
+
<tr>
|
|
387
|
+
<td width="50%">
|
|
388
|
+
|
|
389
|
+
<h3>Contributing</h3>
|
|
390
|
+
<p>We welcome contributions! Check our <a href="https://github.com/knowcode/doc-builder">contribution guide</a> to get started.</p>
|
|
391
|
+
<p><strong>Ways to help:</strong></p>
|
|
392
|
+
<ul>
|
|
393
|
+
<li><i class="ph ph-bug" aria-label="bug"></i> Report bugs</li>
|
|
394
|
+
<li><i class="ph ph-lightbulb" aria-label="idea"></i> Suggest features</li>
|
|
395
|
+
<li><i class="ph ph-note-pencil" aria-label="edit"></i> Improve docs</li>
|
|
396
|
+
<li><i class="ph ph-wrench" aria-label="settings"></i> Submit PRs</li>
|
|
397
|
+
</ul>
|
|
398
|
+
</td>
|
|
399
|
+
<td width="50%">
|
|
400
|
+
|
|
401
|
+
<h3>Community</h3>
|
|
402
|
+
<p>Join our growing community of documentation enthusiasts!</p>
|
|
403
|
+
<p><strong>Connect with us:</strong></p>
|
|
404
|
+
<ul>
|
|
405
|
+
<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/knowcode/doc-builder">GitHub Repo</a></li>
|
|
407
|
+
<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/knowcode/doc-builder/discussions">Discussions</a></li>
|
|
409
|
+
</ul>
|
|
410
|
+
</td>
|
|
411
|
+
</tr>
|
|
412
|
+
</table>
|
|
413
|
+
|
|
298
414
|
<hr>
|
|
299
415
|
<div align="center">
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
<a href="https://knowcode.com">Website</a>
|
|
305
|
-
</p>
|
|
416
|
+
|
|
417
|
+
<h3><i class="ph ph-note-pencil" aria-label="edit"></i> License: MIT © KnowCode</h3>
|
|
418
|
+
<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>View Demo</strong></a> | <a href="https://github.com/knowcode/doc-builder"><strong>Star on GitHub</strong></a></p>
|
|
306
420
|
</div>
|
|
307
421
|
|
|
308
422
|
</div>
|
|
@@ -1905,47 +1905,55 @@ tr:hover {
|
|
|
1905
1905
|
/* Phosphor Icons Alignment */
|
|
1906
1906
|
.ph {
|
|
1907
1907
|
display: inline-block;
|
|
1908
|
-
vertical-align: text-
|
|
1909
|
-
line-height:
|
|
1908
|
+
vertical-align: text-top;
|
|
1909
|
+
line-height: 0.8;
|
|
1910
1910
|
position: relative;
|
|
1911
|
-
top: 0.
|
|
1911
|
+
top: 0.2em; /* Push down to align with x-height of text */
|
|
1912
1912
|
}
|
|
1913
1913
|
|
|
1914
1914
|
/* Ensure icons in headings are properly aligned */
|
|
1915
1915
|
h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
|
|
1916
|
-
font-size: 0.
|
|
1917
|
-
|
|
1918
|
-
top: 0.
|
|
1916
|
+
font-size: 0.85em; /* Slightly smaller in headings */
|
|
1917
|
+
line-height: 0.8;
|
|
1918
|
+
top: 0.15em;
|
|
1919
1919
|
}
|
|
1920
1920
|
|
|
1921
1921
|
/* Icons in lists need special handling */
|
|
1922
1922
|
li .ph {
|
|
1923
1923
|
margin-right: 0.3em;
|
|
1924
|
-
|
|
1924
|
+
font-size: 1.05em;
|
|
1925
|
+
line-height: 0.85;
|
|
1926
|
+
top: 0.15em;
|
|
1925
1927
|
}
|
|
1926
1928
|
|
|
1927
1929
|
/* Icons in tables */
|
|
1928
1930
|
td .ph, th .ph {
|
|
1929
|
-
|
|
1930
|
-
top: 0.
|
|
1931
|
+
line-height: 0.8;
|
|
1932
|
+
top: 0.2em;
|
|
1931
1933
|
}
|
|
1932
1934
|
|
|
1933
1935
|
/* Icons in navigation */
|
|
1934
1936
|
.nav-item .ph,
|
|
1935
1937
|
.nav-title .ph {
|
|
1936
1938
|
vertical-align: middle;
|
|
1939
|
+
line-height: 1;
|
|
1937
1940
|
top: 0; /* Navigation items are flex, so no adjustment needed */
|
|
1938
1941
|
}
|
|
1939
1942
|
|
|
1940
1943
|
/* Icon size adjustments for better visual balance */
|
|
1941
|
-
.content p .ph
|
|
1942
|
-
.
|
|
1943
|
-
font-size: 1.1em; /* Slightly larger than text for visual balance */
|
|
1944
|
+
.content p .ph {
|
|
1945
|
+
font-size: 1.05em; /* Slightly larger than text for visual balance */
|
|
1944
1946
|
}
|
|
1945
1947
|
|
|
1946
1948
|
/* Special handling for inline code with icons */
|
|
1947
1949
|
code .ph {
|
|
1948
1950
|
font-size: 0.9em;
|
|
1949
|
-
vertical-align:
|
|
1951
|
+
vertical-align: middle;
|
|
1952
|
+
line-height: 1;
|
|
1950
1953
|
top: 0;
|
|
1954
|
+
}
|
|
1955
|
+
|
|
1956
|
+
/* Additional fine-tuning for specific contexts */
|
|
1957
|
+
.content-inner .ph {
|
|
1958
|
+
transform: translateY(0.05em); /* Very slight additional adjustment */
|
|
1951
1959
|
}
|
|
@@ -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-22T15:31:48.144Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:31:48.144Z",
|
|
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.16">Last updated: Jul 22, 2025, 03:31 PM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -161,7 +161,8 @@
|
|
|
161
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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
162
162
|
<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="fas fa-file-alt"></i> Seo Guide</a>
|
|
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
|
-
<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
|
|
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
|
+
<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>
|
|
165
166
|
</nav>
|
|
166
167
|
<div class="resize-handle"></div>
|
|
167
168
|
</aside>
|
|
@@ -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-22T15:31:48.146Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:31:48.146Z",
|
|
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.16">Last updated: Jul 22, 2025, 03:31 PM UTC</span>
|
|
106
106
|
</div>
|
|
107
107
|
|
|
108
108
|
|
|
@@ -167,7 +167,8 @@
|
|
|
167
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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
|
|
168
168
|
<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="fas fa-file-alt"></i> Seo Guide</a>
|
|
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
|
-
<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
|
|
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
|
+
<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>
|
|
171
172
|
</nav>
|
|
172
173
|
<div class="resize-handle"></div>
|
|
173
174
|
</aside>
|
|
@@ -198,7 +199,6 @@
|
|
|
198
199
|
</ul>
|
|
199
200
|
<h2>How Authentication Works</h2>
|
|
200
201
|
<div class="mermaid-wrapper">
|
|
201
|
-
<div class="mermaid-title">Diagram</div>
|
|
202
202
|
<div class="mermaid">graph TD
|
|
203
203
|
A[User visits page] --> B{Authenticated?}
|
|
204
204
|
B -->|No| C[Redirect to login]
|
|
@@ -244,7 +244,7 @@
|
|
|
244
244
|
</code></pre>
|
|
245
245
|
<h4>2. Using Presets</h4>
|
|
246
246
|
<p>Use the notion-inspired preset which has authentication enabled by default:</p>
|
|
247
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder build --preset notion-inspired
|
|
247
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build --preset notion-inspired
|
|
248
248
|
</code></pre>
|
|
249
249
|
<p>Default credentials for preset:</p>
|
|
250
250
|
<ul>
|
|
@@ -253,7 +253,7 @@
|
|
|
253
253
|
</ul>
|
|
254
254
|
<h4>3. Command Line</h4>
|
|
255
255
|
<p>Disable authentication for a specific build:</p>
|
|
256
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder build --no-auth
|
|
256
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest build --no-auth
|
|
257
257
|
</code></pre>
|
|
258
258
|
<h3>Configuration Options</h3>
|
|
259
259
|
<table>
|
|
@@ -288,7 +288,7 @@
|
|
|
288
288
|
<h3>For Site Administrators</h3>
|
|
289
289
|
<ol>
|
|
290
290
|
<li><strong>Set Credentials</strong>: Configure username/password in <code>doc-builder.config.js</code></li>
|
|
291
|
-
<li><strong>Build Site</strong>: Run <code>npx @knowcode/doc-builder build</code></li>
|
|
291
|
+
<li><strong>Build Site</strong>: Run <code>npx @knowcode/doc-builder@latest build</code></li>
|
|
292
292
|
<li><strong>Deploy</strong>: Upload to your hosting provider</li>
|
|
293
293
|
<li><strong>Share Credentials</strong>: Provide login details to authorized users</li>
|
|
294
294
|
</ol>
|
|
@@ -407,10 +407,10 @@ module.exports = {
|
|
|
407
407
|
</code></pre>
|
|
408
408
|
<h3>Build and Deploy</h3>
|
|
409
409
|
<pre><code class="language-bash"># Build with authentication
|
|
410
|
-
npx @knowcode/doc-builder build
|
|
410
|
+
npx @knowcode/doc-builder@latest build
|
|
411
411
|
|
|
412
412
|
# Deploy to Vercel
|
|
413
|
-
npx @knowcode/doc-builder deploy
|
|
413
|
+
npx @knowcode/doc-builder@latest deploy
|
|
414
414
|
</code></pre>
|
|
415
415
|
<h3>User Instructions</h3>
|
|
416
416
|
<p>Email to team:</p>
|