@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/index.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>
|
package/html/js/main.js
CHANGED
|
@@ -79,9 +79,6 @@ function initializeMermaidFullScreen() {
|
|
|
79
79
|
const toolbar = document.createElement('div');
|
|
80
80
|
toolbar.className = 'mermaid-toolbar';
|
|
81
81
|
|
|
82
|
-
const title = document.createElement('div');
|
|
83
|
-
title.textContent = 'Mermaid Diagram';
|
|
84
|
-
|
|
85
82
|
const actions = document.createElement('div');
|
|
86
83
|
actions.className = 'mermaid-actions';
|
|
87
84
|
|
|
@@ -91,23 +88,8 @@ function initializeMermaidFullScreen() {
|
|
|
91
88
|
fullScreenBtn.innerHTML = '<i class="fas fa-expand"></i> Full Screen';
|
|
92
89
|
fullScreenBtn.addEventListener('click', () => openMermaidFullScreen(mermaidDiv, index));
|
|
93
90
|
|
|
94
|
-
// Copy SVG button
|
|
95
|
-
const copyBtn = document.createElement('button');
|
|
96
|
-
copyBtn.className = 'mermaid-btn';
|
|
97
|
-
copyBtn.innerHTML = '<i class="fas fa-copy"></i> Copy SVG';
|
|
98
|
-
copyBtn.addEventListener('click', () => copyMermaidSVG(mermaidDiv));
|
|
99
|
-
|
|
100
|
-
// Copy Mermaid source button
|
|
101
|
-
const copyMermaidBtn = document.createElement('button');
|
|
102
|
-
copyMermaidBtn.className = 'mermaid-btn';
|
|
103
|
-
copyMermaidBtn.innerHTML = '<i class="fas fa-code"></i> Copy Mermaid';
|
|
104
|
-
copyMermaidBtn.addEventListener('click', () => copyMermaidSource(mermaidDiv));
|
|
105
|
-
|
|
106
91
|
actions.appendChild(fullScreenBtn);
|
|
107
|
-
actions.appendChild(copyBtn);
|
|
108
|
-
actions.appendChild(copyMermaidBtn);
|
|
109
92
|
|
|
110
|
-
toolbar.appendChild(title);
|
|
111
93
|
toolbar.appendChild(actions);
|
|
112
94
|
|
|
113
95
|
// Create wrapper for the diagram
|
package/html/sitemap.xml
CHANGED
|
@@ -2,97 +2,103 @@
|
|
|
2
2
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|
3
3
|
<url>
|
|
4
4
|
<loc>https://doc-builder-delta.vercel.app/404.html</loc>
|
|
5
|
-
<lastmod>2025-07-
|
|
5
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
6
6
|
<changefreq>monthly</changefreq>
|
|
7
7
|
<priority>0.6</priority>
|
|
8
8
|
</url>
|
|
9
9
|
<url>
|
|
10
10
|
<loc>https://doc-builder-delta.vercel.app/README.html</loc>
|
|
11
|
-
<lastmod>2025-07-
|
|
11
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
12
12
|
<changefreq>monthly</changefreq>
|
|
13
13
|
<priority>0.6</priority>
|
|
14
14
|
</url>
|
|
15
15
|
<url>
|
|
16
16
|
<loc>https://doc-builder-delta.vercel.app/claude-workflow-guide.html</loc>
|
|
17
|
-
<lastmod>2025-07-
|
|
17
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
18
18
|
<changefreq>monthly</changefreq>
|
|
19
19
|
<priority>0.8</priority>
|
|
20
20
|
</url>
|
|
21
21
|
<url>
|
|
22
22
|
<loc>https://doc-builder-delta.vercel.app/documentation-index.html</loc>
|
|
23
|
-
<lastmod>2025-07-
|
|
23
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
24
24
|
<changefreq>monthly</changefreq>
|
|
25
25
|
<priority>0.6</priority>
|
|
26
26
|
</url>
|
|
27
27
|
<url>
|
|
28
28
|
<loc>https://doc-builder-delta.vercel.app/guides/authentication-guide.html</loc>
|
|
29
|
-
<lastmod>2025-07-
|
|
29
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
30
30
|
<changefreq>monthly</changefreq>
|
|
31
31
|
<priority>0.8</priority>
|
|
32
32
|
</url>
|
|
33
33
|
<url>
|
|
34
34
|
<loc>https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html</loc>
|
|
35
|
-
<lastmod>2025-07-
|
|
35
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
36
36
|
<changefreq>monthly</changefreq>
|
|
37
37
|
<priority>0.8</priority>
|
|
38
38
|
</url>
|
|
39
39
|
<url>
|
|
40
40
|
<loc>https://doc-builder-delta.vercel.app/guides/document-standards.html</loc>
|
|
41
|
-
<lastmod>2025-07-
|
|
41
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
42
42
|
<changefreq>monthly</changefreq>
|
|
43
43
|
<priority>0.8</priority>
|
|
44
44
|
</url>
|
|
45
45
|
<url>
|
|
46
46
|
<loc>https://doc-builder-delta.vercel.app/guides/documentation-standards.html</loc>
|
|
47
|
-
<lastmod>2025-07-
|
|
47
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
48
48
|
<changefreq>monthly</changefreq>
|
|
49
49
|
<priority>0.8</priority>
|
|
50
50
|
</url>
|
|
51
51
|
<url>
|
|
52
52
|
<loc>https://doc-builder-delta.vercel.app/guides/google-site-verification-guide.html</loc>
|
|
53
|
-
<lastmod>2025-07-
|
|
53
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
54
54
|
<changefreq>monthly</changefreq>
|
|
55
55
|
<priority>0.8</priority>
|
|
56
56
|
</url>
|
|
57
57
|
<url>
|
|
58
58
|
<loc>https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html</loc>
|
|
59
|
-
<lastmod>2025-07-
|
|
59
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
60
60
|
<changefreq>monthly</changefreq>
|
|
61
61
|
<priority>0.8</priority>
|
|
62
62
|
</url>
|
|
63
63
|
<url>
|
|
64
64
|
<loc>https://doc-builder-delta.vercel.app/guides/seo-guide.html</loc>
|
|
65
|
-
<lastmod>2025-07-
|
|
65
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
66
66
|
<changefreq>monthly</changefreq>
|
|
67
67
|
<priority>0.8</priority>
|
|
68
68
|
</url>
|
|
69
69
|
<url>
|
|
70
70
|
<loc>https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html</loc>
|
|
71
|
-
<lastmod>2025-07-
|
|
71
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
72
72
|
<changefreq>monthly</changefreq>
|
|
73
73
|
<priority>0.8</priority>
|
|
74
74
|
</url>
|
|
75
75
|
<url>
|
|
76
76
|
<loc>https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html</loc>
|
|
77
|
-
<lastmod>2025-07-
|
|
77
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
78
|
+
<changefreq>monthly</changefreq>
|
|
79
|
+
<priority>0.8</priority>
|
|
80
|
+
</url>
|
|
81
|
+
<url>
|
|
82
|
+
<loc>https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html</loc>
|
|
83
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
78
84
|
<changefreq>monthly</changefreq>
|
|
79
85
|
<priority>0.8</priority>
|
|
80
86
|
</url>
|
|
81
87
|
<url>
|
|
82
88
|
<loc>https://doc-builder-delta.vercel.app/index.html</loc>
|
|
83
|
-
<lastmod>2025-07-
|
|
89
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
84
90
|
<changefreq>weekly</changefreq>
|
|
85
91
|
<priority>1.0</priority>
|
|
86
92
|
</url>
|
|
87
93
|
<url>
|
|
88
94
|
<loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
|
|
89
|
-
<lastmod>2025-07-
|
|
95
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
90
96
|
<changefreq>monthly</changefreq>
|
|
91
97
|
<priority>0.8</priority>
|
|
92
98
|
</url>
|
|
93
99
|
<url>
|
|
94
100
|
<loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
|
|
95
|
-
<lastmod>2025-07-
|
|
101
|
+
<lastmod>2025-07-22T15:31:48.192Z</lastmod>
|
|
96
102
|
<changefreq>monthly</changefreq>
|
|
97
103
|
<priority>0.8</priority>
|
|
98
104
|
</url>
|
|
@@ -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.181Z",
|
|
66
|
+
"dateModified": "2025-07-22T15:31:48.181Z",
|
|
67
67
|
"mainEntityOfPage": {
|
|
68
68
|
"@type": "WebPage",
|
|
69
69
|
"@id": "https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.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>
|
|
@@ -208,7 +209,7 @@
|
|
|
208
209
|
</code></pre>
|
|
209
210
|
</li>
|
|
210
211
|
<li><p><strong>Deploy with doc-builder</strong>:</p>
|
|
211
|
-
<pre><code class="language-bash">npx @knowcode/doc-builder deploy
|
|
212
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
212
213
|
</code></pre>
|
|
213
214
|
</li>
|
|
214
215
|
</ol>
|
|
@@ -367,7 +368,7 @@ vercel --scope team-name
|
|
|
367
368
|
<pre><code class="language-yaml"># GitHub Actions example
|
|
368
369
|
- name: Deploy Documentation
|
|
369
370
|
run: |
|
|
370
|
-
npm install -g @knowcode/doc-builder vercel
|
|
371
|
+
npm install -g @knowcode/doc-builder@latest vercel
|
|
371
372
|
doc-builder build
|
|
372
373
|
vercel --prod --token=${{ secrets.VERCEL_TOKEN }}
|
|
373
374
|
</code></pre>
|