@knowcode/doc-builder 1.5.15 → 1.5.16
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/CHANGELOG.md +13 -0
- package/README.md +34 -24
- package/assets/js/main.js +0 -18
- package/html/README.html +205 -91
- package/html/css/notion-style.css +21 -13
- package/html/documentation-index.html +3 -3
- package/html/guides/authentication-guide.html +3 -3
- package/html/guides/claude-workflow-guide.html +3 -3
- package/html/guides/documentation-standards.html +3 -3
- package/html/guides/google-site-verification-guide.html +3 -3
- package/html/guides/phosphor-icons-guide.html +3 -3
- package/html/guides/seo-guide.html +3 -3
- package/html/guides/seo-optimization-guide.html +3 -3
- package/html/guides/troubleshooting-guide.html +3 -3
- package/html/index.html +205 -91
- package/html/sitemap.xml +16 -16
- package/html/vercel-cli-setup-guide.html +3 -3
- package/html/vercel-first-time-setup-guide.html +3 -3
- package/lib/core-builder.js +0 -1
- package/package.json +1 -1
- 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/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,19 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [1.5.16] - 2025-07-22
|
|
9
|
+
|
|
10
|
+
### Changed
|
|
11
|
+
- Simplified Mermaid diagram display by removing unnecessary UI elements
|
|
12
|
+
- Removed "Copy to Mermaid" button from diagram toolbar
|
|
13
|
+
- Removed "Copy SVG" button from diagram toolbar
|
|
14
|
+
- Removed "Diagram" heading from Mermaid diagram wrapper
|
|
15
|
+
- Removed "Mermaid Diagram" text label from toolbar
|
|
16
|
+
|
|
17
|
+
### Improved
|
|
18
|
+
- Cleaner, less cluttered presentation of Mermaid diagrams
|
|
19
|
+
- Full Screen button remains available for better diagram viewing
|
|
20
|
+
|
|
8
21
|
## [1.5.15] - 2025-07-22
|
|
9
22
|
|
|
10
23
|
### Fixed
|
package/README.md
CHANGED
|
@@ -177,7 +177,7 @@ module.exports = {
|
|
|
177
177
|
|
|
178
178
|
<table>
|
|
179
179
|
<tr>
|
|
180
|
-
<td width="
|
|
180
|
+
<td width="50%">
|
|
181
181
|
|
|
182
182
|
### 🏗️ Core Commands
|
|
183
183
|
| Command | Purpose |
|
|
@@ -187,8 +187,14 @@ module.exports = {
|
|
|
187
187
|
| `deploy` | Deploy to Vercel |
|
|
188
188
|
| `init` | Initialize project |
|
|
189
189
|
|
|
190
|
+
### ⚙️ Config Commands
|
|
191
|
+
| Command | Purpose |
|
|
192
|
+
|---------|---------|
|
|
193
|
+
| `set-production-url` | Set custom URL |
|
|
194
|
+
| `reset-vercel` | Clear settings |
|
|
195
|
+
|
|
190
196
|
</td>
|
|
191
|
-
<td width="
|
|
197
|
+
<td width="50%">
|
|
192
198
|
|
|
193
199
|
### 🔍 SEO Commands
|
|
194
200
|
| Command | Purpose |
|
|
@@ -197,14 +203,8 @@ module.exports = {
|
|
|
197
203
|
| `setup-seo` | Configure SEO |
|
|
198
204
|
| `google-verify` | Add verification |
|
|
199
205
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
### ⚙️ Config Commands
|
|
204
|
-
| Command | Purpose |
|
|
205
|
-
|---------|---------|
|
|
206
|
-
| `set-production-url` | Set custom URL |
|
|
207
|
-
| `reset-vercel` | Clear settings |
|
|
206
|
+
### 📚 Documentation
|
|
207
|
+
All commands support `--help` for detailed options and examples.
|
|
208
208
|
|
|
209
209
|
</td>
|
|
210
210
|
</tr>
|
|
@@ -432,22 +432,22 @@ npx @knowcode/doc-builder deploy --production-url my-docs.vercel.app
|
|
|
432
432
|
|
|
433
433
|
<table>
|
|
434
434
|
<tr>
|
|
435
|
-
<td width="
|
|
435
|
+
<td width="50%">
|
|
436
|
+
|
|
437
|
+
### Development Integration
|
|
438
|
+
|
|
439
|
+
**NPM Link (Local Dev)**
|
|
436
440
|
|
|
437
|
-
### NPM Link (Dev)
|
|
438
441
|
```bash
|
|
439
|
-
# In doc-builder
|
|
442
|
+
# In doc-builder directory
|
|
440
443
|
npm link
|
|
441
444
|
|
|
442
445
|
# In your project
|
|
443
446
|
npm link @knowcode/doc-builder
|
|
444
447
|
```
|
|
445
|
-
*For local development*
|
|
446
448
|
|
|
447
|
-
|
|
448
|
-
<td width="33%">
|
|
449
|
+
**File Reference (Monorepos)**
|
|
449
450
|
|
|
450
|
-
### File Reference
|
|
451
451
|
```json
|
|
452
452
|
{
|
|
453
453
|
"devDependencies": {
|
|
@@ -456,22 +456,32 @@ npm link @knowcode/doc-builder
|
|
|
456
456
|
}
|
|
457
457
|
}
|
|
458
458
|
```
|
|
459
|
-
*For monorepos*
|
|
460
459
|
|
|
461
460
|
</td>
|
|
462
|
-
<td width="
|
|
461
|
+
<td width="50%">
|
|
462
|
+
|
|
463
|
+
### Production Integration
|
|
464
|
+
|
|
465
|
+
**NPM Registry (Recommended)**
|
|
466
|
+
|
|
467
|
+
```json
|
|
468
|
+
{
|
|
469
|
+
"devDependencies": {
|
|
470
|
+
"@knowcode/doc-builder": "^1.5.14"
|
|
471
|
+
}
|
|
472
|
+
}
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
**Git Repository (Private)**
|
|
463
476
|
|
|
464
|
-
### Git Repository
|
|
465
477
|
```json
|
|
466
478
|
{
|
|
467
479
|
"devDependencies": {
|
|
468
480
|
"@knowcode/doc-builder":
|
|
469
|
-
"git+https://github.com/
|
|
470
|
-
knowcode/doc-builder.git"
|
|
481
|
+
"git+https://github.com/knowcode/doc-builder.git"
|
|
471
482
|
}
|
|
472
483
|
}
|
|
473
484
|
```
|
|
474
|
-
*For private repos*
|
|
475
485
|
|
|
476
486
|
</td>
|
|
477
487
|
</tr>
|
|
@@ -491,4 +501,4 @@ MIT License - See [LICENSE](LICENSE) file for details
|
|
|
491
501
|
|
|
492
502
|
Made with ❤️ by the @knowcode team
|
|
493
503
|
|
|
494
|
-
</div>
|
|
504
|
+
</div>
|
package/assets/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/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-22T11:
|
|
66
|
-
"dateModified": "2025-07-22T11:
|
|
65
|
+
"datePublished": "2025-07-22T11:52:26.119Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:52:26.119Z",
|
|
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.15">Last updated: Jul 22, 2025, 11:52 AM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|
|
@@ -170,139 +170,253 @@
|
|
|
170
170
|
<main class="content">
|
|
171
171
|
<div class="content-inner">
|
|
172
172
|
<h1>@knowcode/doc-builder</h1>
|
|
173
|
+
<div align="center">
|
|
174
|
+
|
|
173
175
|
<blockquote>
|
|
174
176
|
<p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
|
|
175
177
|
</blockquote>
|
|
176
178
|
<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
|
|
179
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h3>
|
|
180
|
+
<pre><code class="language-bash">npx @knowcode/doc-builder@latest deploy
|
|
184
181
|
</code></pre>
|
|
182
|
+
<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>
|
|
183
|
+
</div>
|
|
184
|
+
|
|
185
|
+
<hr>
|
|
185
186
|
<h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
|
|
186
|
-
<
|
|
187
|
+
<table>
|
|
188
|
+
<tr>
|
|
189
|
+
<td width="50%">
|
|
190
|
+
|
|
191
|
+
<h3><i class="ph ph-palette" aria-label="design"></i> Design & UX</h3>
|
|
187
192
|
<ul>
|
|
188
|
-
<li><strong>Notion-inspired UI</strong> - Clean, modern interface
|
|
193
|
+
<li><strong>Notion-inspired UI</strong> - Clean, modern interface</li>
|
|
189
194
|
<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
|
|
195
|
+
<li><strong>Responsive layout</strong> - Perfect on any device</li>
|
|
196
|
+
<li><strong>Syntax highlighting</strong> - Beautiful code blocks</li>
|
|
192
197
|
</ul>
|
|
193
|
-
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i>
|
|
198
|
+
<h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Navigation</h3>
|
|
194
199
|
<ul>
|
|
195
200
|
<li><strong>Full-text search</strong> - Find anything instantly</li>
|
|
196
|
-
<li><strong>Smart navigation</strong> - Hierarchical
|
|
201
|
+
<li><strong>Smart navigation</strong> - Hierarchical structure</li>
|
|
197
202
|
<li><strong>Breadcrumbs</strong> - Always know where you are</li>
|
|
198
203
|
<li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
|
|
199
204
|
</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>
|
|
205
|
+
</td>
|
|
206
|
+
<td width="50%">
|
|
207
|
+
|
|
208
|
+
<h3><i class="ph ph-chart-bar" aria-label="chart"></i> Content Support</h3>
|
|
208
209
|
<ul>
|
|
209
|
-
<li><strong>
|
|
210
|
-
<li><strong>
|
|
211
|
-
<li><strong>
|
|
212
|
-
<li><strong>
|
|
210
|
+
<li><strong>Mermaid diagrams</strong> - Visual documentation</li>
|
|
211
|
+
<li><strong>GitHub markdown</strong> - Full GFM support</li>
|
|
212
|
+
<li><strong>Interactive tooltips</strong> - Document previews</li>
|
|
213
|
+
<li><strong>Version tracking</strong> - Build metadata</li>
|
|
213
214
|
</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>
|
|
215
|
+
<h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Deployment</h3>
|
|
217
216
|
<ul>
|
|
218
|
-
<li><strong>
|
|
219
|
-
<li><strong>
|
|
220
|
-
<li><strong>
|
|
221
|
-
<li><strong>
|
|
217
|
+
<li><strong>One-command deploy</strong> - Push to Vercel</li>
|
|
218
|
+
<li><strong>Static generation</strong> - Fast & secure</li>
|
|
219
|
+
<li><strong>Custom domains</strong> - Your brand</li>
|
|
220
|
+
<li><strong>Preview deploys</strong> - Test changes</li>
|
|
222
221
|
</ul>
|
|
222
|
+
</td>
|
|
223
|
+
</tr>
|
|
224
|
+
</table>
|
|
225
|
+
|
|
226
|
+
<h2><i class="ph ph-target" aria-label="goal"></i> Use Cases</h2>
|
|
227
|
+
<table>
|
|
228
|
+
<tr>
|
|
229
|
+
<td width="25%">
|
|
230
|
+
|
|
231
|
+
<h3>Open Source</h3>
|
|
232
|
+
<p>Beautiful docs for your community</p>
|
|
233
|
+
</td>
|
|
234
|
+
<td width="25%">
|
|
235
|
+
|
|
236
|
+
<h3>Technical Teams</h3>
|
|
237
|
+
<p>Internal docs developers love</p>
|
|
238
|
+
</td>
|
|
239
|
+
<td width="25%">
|
|
240
|
+
|
|
241
|
+
<h3>API Docs</h3>
|
|
242
|
+
<p>Clear, searchable references</p>
|
|
243
|
+
</td>
|
|
244
|
+
<td width="25%">
|
|
245
|
+
|
|
246
|
+
<h3>Knowledge Base</h3>
|
|
247
|
+
<p>Organize team knowledge</p>
|
|
248
|
+
</td>
|
|
249
|
+
</tr>
|
|
250
|
+
</table>
|
|
251
|
+
|
|
223
252
|
<h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
|
|
224
|
-
<
|
|
253
|
+
<table>
|
|
254
|
+
<tr>
|
|
255
|
+
<td width="25%">
|
|
256
|
+
|
|
257
|
+
<h3>1️⃣ Initialize</h3>
|
|
225
258
|
<pre><code class="language-bash">npx @knowcode/doc-builder init
|
|
226
259
|
</code></pre>
|
|
227
|
-
<
|
|
228
|
-
|
|
229
|
-
<
|
|
260
|
+
<p><em>Create project structure</em></p>
|
|
261
|
+
</td>
|
|
262
|
+
<td width="25%">
|
|
230
263
|
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
\`\`\`bash
|
|
236
|
-
npm install amazing-package
|
|
237
|
-
\`\`\`
|
|
264
|
+
<h3>2️⃣ Write Docs</h3>
|
|
265
|
+
<pre><code class="language-markdown"># Getting Started
|
|
266
|
+
Welcome to our docs!
|
|
238
267
|
|
|
239
268
|
## Features
|
|
240
|
-
|
|
241
269
|
- <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
|
|
242
270
|
- <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
271
|
</code></pre>
|
|
245
|
-
<
|
|
246
|
-
|
|
247
|
-
|
|
272
|
+
<p><em>Use markdown files</em></p>
|
|
273
|
+
</td>
|
|
274
|
+
<td width="25%">
|
|
248
275
|
|
|
249
|
-
|
|
250
|
-
npx doc-builder
|
|
276
|
+
<h3>3️⃣ Preview</h3>
|
|
277
|
+
<pre><code class="language-bash">npx doc-builder dev
|
|
251
278
|
</code></pre>
|
|
252
|
-
<
|
|
279
|
+
<p><em>Live development server</em></p>
|
|
280
|
+
</td>
|
|
281
|
+
<td width="25%">
|
|
282
|
+
|
|
283
|
+
<h3>4️⃣ Deploy</h3>
|
|
253
284
|
<pre><code class="language-bash">npx doc-builder deploy
|
|
254
285
|
</code></pre>
|
|
255
|
-
<
|
|
256
|
-
|
|
286
|
+
<p><em>Push to production</em></p>
|
|
287
|
+
</td>
|
|
288
|
+
</tr>
|
|
289
|
+
</table>
|
|
290
|
+
|
|
291
|
+
<h2><i class="ph ph-gear" aria-label="settings"></i> Configuration</h2>
|
|
292
|
+
<table>
|
|
293
|
+
<tr>
|
|
294
|
+
<td width="50%">
|
|
295
|
+
|
|
296
|
+
<h3>Basic Config</h3>
|
|
257
297
|
<pre><code class="language-javascript">module.exports = {
|
|
258
298
|
siteName: 'Your Amazing Docs',
|
|
259
|
-
siteDescription: '
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
darkMode: true,
|
|
263
|
-
authentication: false
|
|
264
|
-
}
|
|
299
|
+
siteDescription: 'Docs developers love',
|
|
300
|
+
docsDir: 'docs',
|
|
301
|
+
outputDir: 'html'
|
|
265
302
|
};
|
|
266
303
|
</code></pre>
|
|
267
|
-
|
|
268
|
-
<
|
|
304
|
+
</td>
|
|
305
|
+
<td width="50%">
|
|
306
|
+
|
|
307
|
+
<h3>Advanced Features</h3>
|
|
308
|
+
<pre><code class="language-javascript">features: {
|
|
309
|
+
mermaid: true, // Diagrams
|
|
310
|
+
darkMode: true, // Theme toggle
|
|
311
|
+
authentication: true, // Password
|
|
312
|
+
changelog: true // Auto-generate
|
|
313
|
+
}
|
|
314
|
+
</code></pre>
|
|
315
|
+
</td>
|
|
316
|
+
</tr>
|
|
317
|
+
</table>
|
|
318
|
+
|
|
319
|
+
<h2><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Examples</h2>
|
|
320
|
+
<table>
|
|
321
|
+
<tr>
|
|
322
|
+
<td width="50%">
|
|
323
|
+
|
|
324
|
+
<h3>Mermaid Diagrams</h3>
|
|
269
325
|
<div class="mermaid-wrapper">
|
|
270
326
|
<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-22T11:
|
|
66
|
-
"dateModified": "2025-07-22T11:
|
|
65
|
+
"datePublished": "2025-07-22T11:52:26.129Z",
|
|
66
|
+
"dateModified": "2025-07-22T11:52:26.129Z",
|
|
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.15">Last updated: Jul 22, 2025, 11:52 AM UTC</span>
|
|
100
100
|
</div>
|
|
101
101
|
|
|
102
102
|
|