@knowcode/doc-builder 1.5.12 → 1.5.13

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/html/index.html CHANGED
@@ -36,6 +36,7 @@
36
36
 
37
37
  <!-- Icons -->
38
38
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
39
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
39
40
 
40
41
  <!-- Mermaid -->
41
42
  <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
@@ -61,8 +62,8 @@
61
62
  "name": "Knowcode Ltd",
62
63
  "url": "https://knowcode.tech"
63
64
  },
64
- "datePublished": "2025-07-22T08:32:13.098Z",
65
- "dateModified": "2025-07-22T08:32:13.098Z",
65
+ "datePublished": "2025-07-22T11:03:54.314Z",
66
+ "dateModified": "2025-07-22T11:03:54.314Z",
66
67
  "mainEntityOfPage": {
67
68
  "@type": "WebPage",
68
69
  "@id": "https://doc-builder-delta.vercel.app/README.html"
@@ -95,7 +96,7 @@
95
96
 
96
97
  <div class="header-actions">
97
98
  <div class="deployment-info">
98
- <span class="deployment-date" title="Built with doc-builder v1.5.9">Last updated: Jul 22, 2025, 08:32 AM UTC</span>
99
+ <span class="deployment-date" title="Built with doc-builder v1.5.12">Last updated: Jul 22, 2025, 11:03 AM UTC</span>
99
100
  </div>
100
101
 
101
102
 
@@ -146,8 +147,8 @@
146
147
  <div class="nav-content" >
147
148
  <a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
148
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>
149
- <a href="/vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing and configuring the Vercel CLI across different operating systems and environments."><i class="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
150
- <a href="/vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide provides a detailed explanation of every prompt you&#039;ll encounter during the first-time Vercel setup process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
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 streamlined Vercel deployment process when using."><i class="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
151
152
  <div class="nav-section" data-level="1">
152
153
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
153
154
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
@@ -172,7 +173,7 @@
172
173
  <p>Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling</p>
173
174
  </blockquote>
174
175
  <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>
175
- <h2>🚀 Quick Start</h2>
176
+ <h2><i class="ph ph-rocket-launch" aria-label="launch"></i> Quick Start</h2>
176
177
  <p>Create stunning documentation sites in minutes:</p>
177
178
  <pre><code class="language-bash"># Install globally
178
179
  npm install -g @knowcode/doc-builder
@@ -180,45 +181,45 @@ npm install -g @knowcode/doc-builder
180
181
  # Or use with npx
181
182
  npx @knowcode/doc-builder@latest deploy
182
183
  </code></pre>
183
- <h2>✨ Features</h2>
184
- <h3>🎨 Beautiful Design</h3>
184
+ <h2><i class="ph ph-sparkle" aria-label="special"></i> Features</h2>
185
+ <h3><i class="ph ph-palette" aria-label="design"></i> Beautiful Design</h3>
185
186
  <ul>
186
187
  <li><strong>Notion-inspired UI</strong> - Clean, modern interface that users love</li>
187
188
  <li><strong>Dark mode support</strong> - Automatic theme switching</li>
188
189
  <li><strong>Responsive layout</strong> - Perfect on desktop and mobile</li>
189
190
  <li><strong>Syntax highlighting</strong> - Beautiful code blocks with language support</li>
190
191
  </ul>
191
- <h3>🔍 Powerful Search &amp; Navigation</h3>
192
+ <h3><i class="ph ph-magnifying-glass" aria-label="search"></i> Powerful Search &amp; Navigation</h3>
192
193
  <ul>
193
194
  <li><strong>Full-text search</strong> - Find anything instantly</li>
194
195
  <li><strong>Smart navigation</strong> - Hierarchical folder structure</li>
195
196
  <li><strong>Breadcrumbs</strong> - Always know where you are</li>
196
197
  <li><strong>Keyboard shortcuts</strong> - Navigate like a pro</li>
197
198
  </ul>
198
- <h3>📊 Rich Content Support</h3>
199
+ <h3><i class="ph ph-chart-bar" aria-label="chart"></i> Rich Content Support</h3>
199
200
  <ul>
200
201
  <li><strong>Mermaid diagrams</strong> - Flowcharts, sequence diagrams, and more</li>
201
202
  <li><strong>GitHub-flavored markdown</strong> - Tables, task lists, and strikethrough</li>
202
203
  <li><strong>Interactive tooltips</strong> - Document summaries on hover</li>
203
204
  <li><strong>Version tracking</strong> - Know which version built your docs</li>
204
205
  </ul>
205
- <h3>🚀 Easy Deployment</h3>
206
+ <h3><i class="ph ph-rocket-launch" aria-label="launch"></i> Easy Deployment</h3>
206
207
  <ul>
207
208
  <li><strong>One-command deploy</strong> - Push to Vercel instantly</li>
208
209
  <li><strong>Static site generation</strong> - Fast, secure, and scalable</li>
209
210
  <li><strong>Custom domains</strong> - Your docs, your brand</li>
210
211
  <li><strong>Preview deployments</strong> - Test before going live</li>
211
212
  </ul>
212
- <h2>📖 Documentation</h2>
213
+ <h2><i class="ph ph-book-open" aria-label="reading"></i> Documentation</h2>
213
214
  <p>Visit our <a href="https://www.npmjs.com/package/@knowcode/doc-builder">official documentation</a> for detailed guides and API reference.</p>
214
- <h2>🎯 Perfect For</h2>
215
+ <h2><i class="ph ph-target" aria-label="goal"></i> Perfect For</h2>
215
216
  <ul>
216
217
  <li><strong>Open source projects</strong> - Beautiful docs for your community</li>
217
218
  <li><strong>Technical teams</strong> - Internal documentation that developers actually use</li>
218
219
  <li><strong>API documentation</strong> - Clear, searchable API references</li>
219
220
  <li><strong>Knowledge bases</strong> - Organize and share team knowledge</li>
220
221
  </ul>
221
- <h2>🛠️ Simple Workflow</h2>
222
+ <h2><i class="ph ph-gear-six" aria-label="tools"></i> Simple Workflow</h2>
222
223
  <h3>1. Initialize Your Project</h3>
223
224
  <pre><code class="language-bash">npx @knowcode/doc-builder init
224
225
  </code></pre>
@@ -236,9 +237,9 @@ npm install amazing-package
236
237
 
237
238
  ## Features
238
239
 
239
- - Feature one
240
- - Feature two
241
- - Feature three
240
+ - <i class="ph ph-check-circle" aria-label="checked"></i> Feature one
241
+ - <i class="ph ph-check-circle" aria-label="checked"></i> Feature two
242
+ - <i class="ph ph-check-circle" aria-label="checked"></i> Feature three
242
243
  </code></pre>
243
244
  <h3>3. Build &amp; Preview</h3>
244
245
  <pre><code class="language-bash"># Build your site
@@ -250,7 +251,7 @@ npx doc-builder serve
250
251
  <h3>4. Deploy to Vercel</h3>
251
252
  <pre><code class="language-bash">npx doc-builder deploy
252
253
  </code></pre>
253
- <h2>🎨 Customization</h2>
254
+ <h2><i class="ph ph-palette" aria-label="design"></i> Customization</h2>
254
255
  <p>Configure your site with <code>doc-builder.config.js</code>:</p>
255
256
  <pre><code class="language-javascript">module.exports = {
256
257
  siteName: &#39;Your Amazing Docs&#39;,
@@ -262,7 +263,7 @@ npx doc-builder serve
262
263
  }
263
264
  };
264
265
  </code></pre>
265
- <h2>📊 Mermaid Diagram Support</h2>
266
+ <h2><i class="ph ph-chart-bar" aria-label="chart"></i> Mermaid Diagram Support</h2>
266
267
  <p>Create beautiful diagrams in your markdown:</p>
267
268
  <div class="mermaid-wrapper">
268
269
  <div class="mermaid-title">Diagram</div>
@@ -274,13 +275,13 @@ npx doc-builder serve
274
275
  style A fill:#e1f5fe
275
276
  style D fill:#c8e6c9</div>
276
277
  </div>
277
- <h2>🔒 Optional Authentication</h2>
278
+ <h2><i class="ph ph-lock" aria-label="locked"></i> Optional Authentication</h2>
278
279
  <p>Protect sensitive documentation with built-in authentication:</p>
279
280
  <pre><code class="language-javascript">features: {
280
281
  authentication: true
281
282
  }
282
283
  </code></pre>
283
- <h2>🌟 Why doc-builder?</h2>
284
+ <h2><i class="ph ph-star-four" aria-label="sparkle"></i> Why doc-builder?</h2>
284
285
  <ul>
285
286
  <li><strong>Zero configuration</strong> - Works out of the box</li>
286
287
  <li><strong>Lightning fast</strong> - Static site generation for instant loading</li>
@@ -289,13 +290,13 @@ npx doc-builder serve
289
290
  <li><strong>Version control</strong> - Track changes with Git</li>
290
291
  <li><strong>Open source</strong> - MIT licensed</li>
291
292
  </ul>
292
- <h2>🤝 Contributing</h2>
293
+ <h2><i class="ph ph-handshake" aria-label="partnership"></i> Contributing</h2>
293
294
  <p>We welcome contributions! Check out our <a href="https://github.com/knowcode/doc-builder">contribution guide</a> to get started.</p>
294
- <h2>📝 License</h2>
295
+ <h2><i class="ph ph-note-pencil" aria-label="edit"></i> License</h2>
295
296
  <p>MIT © KnowCode</p>
296
297
  <hr>
297
298
  <div align="center">
298
- <p>Built with ❤️ by developers, for developers</p>
299
+ <p>Built with <i class="ph ph-heart" aria-label="love"></i> by developers, for developers</p>
299
300
  <p>
300
301
  <a href="https://www.npmjs.com/package/@knowcode/doc-builder">npm</a> •
301
302
  <a href="https://github.com/knowcode/doc-builder">GitHub</a> •
package/html/sitemap.xml CHANGED
@@ -2,91 +2,91 @@
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-22T08:32:13.156Z</lastmod>
5
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
11
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
17
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
23
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
29
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
35
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
41
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
47
+ <lastmod>2025-07-22T11:03:54.359Z</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-22T08:32:13.156Z</lastmod>
53
+ <lastmod>2025-07-22T11:03:54.359Z</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/seo-guide.html</loc>
59
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
59
+ <lastmod>2025-07-22T11:03:54.359Z</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-optimization-guide.html</loc>
65
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
65
+ <lastmod>2025-07-22T11:03:54.359Z</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/troubleshooting-guide.html</loc>
71
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
71
+ <lastmod>2025-07-22T11:03:54.359Z</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/index.html</loc>
77
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
77
+ <lastmod>2025-07-22T11:03:54.359Z</lastmod>
78
78
  <changefreq>weekly</changefreq>
79
79
  <priority>1.0</priority>
80
80
  </url>
81
81
  <url>
82
82
  <loc>https://doc-builder-delta.vercel.app/vercel-cli-setup-guide.html</loc>
83
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
83
+ <lastmod>2025-07-22T11:03:54.359Z</lastmod>
84
84
  <changefreq>monthly</changefreq>
85
85
  <priority>0.8</priority>
86
86
  </url>
87
87
  <url>
88
88
  <loc>https://doc-builder-delta.vercel.app/vercel-first-time-setup-guide.html</loc>
89
- <lastmod>2025-07-22T08:32:13.156Z</lastmod>
89
+ <lastmod>2025-07-22T11:03:54.359Z</lastmod>
90
90
  <changefreq>monthly</changefreq>
91
91
  <priority>0.8</priority>
92
92
  </url>