@knowcode/doc-builder 1.6.4 → 1.7.0

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.
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:05.998Z",
67
- "dateModified": "2025-07-23T09:32:05.998Z",
66
+ "datePublished": "2025-07-24T08:19:52.224Z",
67
+ "dateModified": "2025-07-24T08:19:52.224Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/phosphor-icons-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -192,9 +192,9 @@
192
192
  <h2>How It Works</h2>
193
193
  <h3>Automatic Conversion</h3>
194
194
  <p>When you write emojis in your markdown:</p>
195
- <pre><code class="language-markdown"><i class="ph ph-check-circle" aria-label="checked"></i> Task completed
196
- <i class="ph ph-x-circle" aria-label="error"></i> Issue found
197
- <i class="ph ph-rocket-launch" aria-label="launch"></i> Launching feature
195
+ <pre><code class="language-markdown">✅ Task completed
196
+ Issue found
197
+ 🚀 Launching feature
198
198
  </code></pre>
199
199
  <p>They are automatically converted to Phosphor icons in HTML:</p>
200
200
  <ul>
@@ -369,23 +369,23 @@
369
369
  </ul>
370
370
  <h2>Usage Examples</h2>
371
371
  <h3>In Markdown Headers</h3>
372
- <pre><code class="language-markdown">## <i class="ph ph-rocket-launch" aria-label="launch"></i> Getting Started
373
- ## <i class="ph ph-wrench" aria-label="settings"></i> Configuration
374
- ## <i class="ph ph-books" aria-label="documentation"></i> API Reference
375
- ## <i class="ph ph-x-circle" aria-label="error"></i> Common Errors
372
+ <pre><code class="language-markdown">## 🚀 Getting Started
373
+ ## 🔧 Configuration
374
+ ## 📚 API Reference
375
+ ## Common Errors
376
376
  </code></pre>
377
377
  <h3>In Lists</h3>
378
- <pre><code class="language-markdown">- <i class="ph ph-check-circle" aria-label="checked"></i> Feature implemented
378
+ <pre><code class="language-markdown">- Feature implemented
379
379
  - 🚧 Work in progress
380
- - <i class="ph ph-x-circle" aria-label="error"></i> Deprecated
381
- - <i class="ph ph-lightbulb" aria-label="idea"></i> Pro tip
380
+ - Deprecated
381
+ - 💡 Pro tip
382
382
  </code></pre>
383
383
  <h3>In Tables</h3>
384
384
  <pre><code class="language-markdown">| Status | Feature | Notes |
385
385
  |--------|---------|-------|
386
- | <i class="ph ph-check-circle" aria-label="checked"></i> | Search | Ready |
386
+ | | Search | Ready |
387
387
  | 🚧 | Auth | In progress |
388
- | <i class="ph ph-x-circle" aria-label="error"></i> | Legacy API | Deprecated |
388
+ | | Legacy API | Deprecated |
389
389
  </code></pre>
390
390
  <h2>Customization</h2>
391
391
  <h3>Custom Icon Sizes</h3>
@@ -491,6 +491,15 @@
491
491
  </div>
492
492
 
493
493
  <!-- Scripts -->
494
+ <script>
495
+ // Pass configuration to frontend
496
+ window.docBuilderConfig = {
497
+ features: {
498
+ showPdfDownload: true,
499
+ menuDefaultOpen: true
500
+ }
501
+ };
502
+ </script>
494
503
  <script src="/js/main.js"></script>
495
504
 
496
505
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.044Z",
67
- "dateModified": "2025-07-23T09:32:06.044Z",
66
+ "datePublished": "2025-07-24T08:19:52.236Z",
67
+ "dateModified": "2025-07-24T08:19:52.236Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/search-engine-verification-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -449,6 +449,15 @@ doc-builder bing-verify NEW_BING_CODE
449
449
  </div>
450
450
 
451
451
  <!-- Scripts -->
452
+ <script>
453
+ // Pass configuration to frontend
454
+ window.docBuilderConfig = {
455
+ features: {
456
+ showPdfDownload: true,
457
+ menuDefaultOpen: true
458
+ }
459
+ };
460
+ </script>
452
461
  <script src="/js/main.js"></script>
453
462
 
454
463
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.059Z",
67
- "dateModified": "2025-07-23T09:32:06.059Z",
66
+ "datePublished": "2025-07-24T08:19:52.243Z",
67
+ "dateModified": "2025-07-24T08:19:52.243Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -424,10 +424,10 @@ author: Different Author
424
424
  <pre><code class="language-bash">npx @knowcode/doc-builder@latest build
425
425
  </code></pre>
426
426
  <p>You&#39;ll see SEO generation in the output:</p>
427
- <pre><code><i class="ph ph-map-trifold" aria-label="map"></i> Generating sitemap.xml...
428
- <i class="ph ph-check-circle" aria-label="checked"></i> Generated sitemap.xml with 23 URLs
429
- <i class="ph ph-robot" aria-label="automation"></i> Generating robots.txt...
430
- <i class="ph ph-check-circle" aria-label="checked"></i> Generated robots.txt
427
+ <pre><code>🗺️ Generating sitemap.xml...
428
+ Generated sitemap.xml with 23 URLs
429
+ 🤖 Generating robots.txt...
430
+ Generated robots.txt
431
431
  </code></pre>
432
432
  <h3>2. Check Generated Files</h3>
433
433
  <ul>
@@ -568,6 +568,15 @@ author: Different Author
568
568
  </div>
569
569
 
570
570
  <!-- Scripts -->
571
+ <script>
572
+ // Pass configuration to frontend
573
+ window.docBuilderConfig = {
574
+ features: {
575
+ showPdfDownload: true,
576
+ menuDefaultOpen: true
577
+ }
578
+ };
579
+ </script>
571
580
  <script src="/js/main.js"></script>
572
581
 
573
582
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.091Z",
67
- "dateModified": "2025-07-23T09:32:06.091Z",
66
+ "datePublished": "2025-07-24T08:19:52.252Z",
67
+ "dateModified": "2025-07-24T08:19:52.252Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/seo-optimization-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -410,13 +410,13 @@ doc-builder seo-check html/guide.html
410
410
  <li><i class="ph ph-check-circle" aria-label="checked"></i> <strong>Structured data</strong> - JSON-LD implementation</li>
411
411
  </ul>
412
412
  <h3>Example Output</h3>
413
- <pre><code><i class="ph ph-magnifying-glass" aria-label="search"></i> Analyzing SEO in generated HTML files...
413
+ <pre><code>🔍 Analyzing SEO in generated HTML files...
414
414
 
415
- <i class="ph ph-chart-bar" aria-label="chart"></i> SEO Analysis Complete
415
+ 📊 SEO Analysis Complete
416
416
 
417
417
  Analyzed 14 files
418
418
 
419
- <i class="ph ph-x-circle" aria-label="error"></i> Found 2 issues:
419
+ Found 2 issues:
420
420
 
421
421
  guides/api.html:
422
422
  Title too long (75 chars, max 60)
@@ -425,7 +425,7 @@ Analyzed 14 files
425
425
  setup.html:
426
426
  Missing meta description
427
427
 
428
- <i class="ph ph-lightbulb" aria-label="idea"></i> 8 suggestions:
428
+ 💡 8 suggestions:
429
429
 
430
430
  index.html: Description too short (95 chars, ideal 140-160)
431
431
  guides/auth.html: No keywords meta tag found
@@ -794,6 +794,15 @@ doc-builder deploy
794
794
  </div>
795
795
 
796
796
  <!-- Scripts -->
797
+ <script>
798
+ // Pass configuration to frontend
799
+ window.docBuilderConfig = {
800
+ features: {
801
+ showPdfDownload: true,
802
+ menuDefaultOpen: true
803
+ }
804
+ };
805
+ </script>
797
806
  <script src="/js/main.js"></script>
798
807
 
799
808
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.240Z",
67
- "dateModified": "2025-07-23T09:32:06.240Z",
66
+ "datePublished": "2025-07-24T08:19:52.257Z",
67
+ "dateModified": "2025-07-24T08:19:52.257Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/troubleshooting-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -540,6 +540,15 @@ npm --version
540
540
  </div>
541
541
 
542
542
  <!-- Scripts -->
543
+ <script>
544
+ // Pass configuration to frontend
545
+ window.docBuilderConfig = {
546
+ features: {
547
+ showPdfDownload: true,
548
+ menuDefaultOpen: true
549
+ }
550
+ };
551
+ </script>
543
552
  <script src="/js/main.js"></script>
544
553
 
545
554
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.277Z",
67
- "dateModified": "2025-07-23T09:32:06.277Z",
66
+ "datePublished": "2025-07-24T08:19:52.265Z",
67
+ "dateModified": "2025-07-24T08:19:52.265Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/guides/windows-setup-guide.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -766,6 +766,15 @@ npm cache clean --force
766
766
  </div>
767
767
 
768
768
  <!-- Scripts -->
769
+ <script>
770
+ // Pass configuration to frontend
771
+ window.docBuilderConfig = {
772
+ features: {
773
+ showPdfDownload: true,
774
+ menuDefaultOpen: true
775
+ }
776
+ };
777
+ </script>
769
778
  <script src="/js/main.js"></script>
770
779
 
771
780
  </body>
package/html/index.html CHANGED
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:05.950Z",
67
- "dateModified": "2025-07-23T09:32:05.950Z",
66
+ "datePublished": "2025-07-24T08:19:52.195Z",
67
+ "dateModified": "2025-07-24T08:19:52.195Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/README.html"
@@ -97,7 +97,7 @@
97
97
 
98
98
  <div class="header-actions">
99
99
  <div class="deployment-info">
100
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
100
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
101
101
  </div>
102
102
 
103
103
 
@@ -294,7 +294,7 @@ module.exports = {
294
294
  siteDescription: &#39;Transform markdown into beautiful documentation&#39;,
295
295
  docsDir: &#39;docs&#39;,
296
296
  outputDir: &#39;html&#39;,
297
- favicon: &#39;<i class="ph ph-sparkle" aria-label="special"></i>&#39; // Can be emoji or path to image
297
+ favicon: &#39;✨&#39; // Can be emoji or path to image
298
298
  };
299
299
  </code></pre>
300
300
  <p><em>The CLI creates and updates this for you</em></p>
@@ -422,6 +422,15 @@ docBuilder.build({
422
422
  </div>
423
423
 
424
424
  <!-- Scripts -->
425
+ <script>
426
+ // Pass configuration to frontend
427
+ window.docBuilderConfig = {
428
+ features: {
429
+ showPdfDownload: true,
430
+ menuDefaultOpen: true
431
+ }
432
+ };
433
+ </script>
425
434
  <script src="/js/main.js"></script>
426
435
 
427
436
  </body>
package/html/js/main.js CHANGED
@@ -494,6 +494,14 @@ function updateThemeIcon(theme) {
494
494
  const menuToggle = document.getElementById('menu-toggle');
495
495
  const sidebar = document.querySelector('.sidebar');
496
496
 
497
+ // Set initial menu state based on configuration
498
+ if (sidebar && window.innerWidth > 768) {
499
+ const menuDefaultOpen = window.docBuilderConfig?.features?.menuDefaultOpen !== false;
500
+ if (!menuDefaultOpen) {
501
+ sidebar.classList.add('closed');
502
+ }
503
+ }
504
+
497
505
  // Create overlay element for mobile
498
506
  let overlay = document.querySelector('.sidebar-overlay');
499
507
  if (!overlay && window.innerWidth <= 768) {
@@ -504,7 +512,13 @@ if (!overlay && window.innerWidth <= 768) {
504
512
 
505
513
  if (menuToggle) {
506
514
  menuToggle.addEventListener('click', () => {
507
- sidebar.classList.toggle('open');
515
+ if (window.innerWidth <= 768) {
516
+ // Mobile: toggle 'open' class
517
+ sidebar.classList.toggle('open');
518
+ } else {
519
+ // Desktop: toggle 'closed' class
520
+ sidebar.classList.toggle('closed');
521
+ }
508
522
  if (overlay) {
509
523
  overlay.classList.toggle('active');
510
524
  }
@@ -1278,6 +1292,10 @@ function exportToPDF() {
1278
1292
 
1279
1293
  // Add PDF export button functionality
1280
1294
  function addPDFExportButton() {
1295
+ // Check configuration - default to true if not set
1296
+ const showPdfDownload = window.docBuilderConfig?.features?.showPdfDownload !== false;
1297
+ if (!showPdfDownload) return;
1298
+
1281
1299
  const headerActions = document.querySelector('.header-actions');
1282
1300
  if (headerActions) {
1283
1301
  const pdfButton = document.createElement('button');
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.279Z",
67
- "dateModified": "2025-07-23T09:32:06.279Z",
66
+ "datePublished": "2025-07-24T08:19:52.268Z",
67
+ "dateModified": "2025-07-24T08:19:52.268Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/launch/README.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -272,6 +272,15 @@
272
272
  </div>
273
273
 
274
274
  <!-- Scripts -->
275
+ <script>
276
+ // Pass configuration to frontend
277
+ window.docBuilderConfig = {
278
+ features: {
279
+ showPdfDownload: true,
280
+ menuDefaultOpen: true
281
+ }
282
+ };
283
+ </script>
275
284
  <script src="/js/main.js"></script>
276
285
 
277
286
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.285Z",
67
- "dateModified": "2025-07-23T09:32:06.285Z",
66
+ "datePublished": "2025-07-24T08:19:52.272Z",
67
+ "dateModified": "2025-07-24T08:19:52.272Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/launch/bubble-plugin-specification.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -908,6 +908,15 @@ generateDocs({
908
908
  </div>
909
909
 
910
910
  <!-- Scripts -->
911
+ <script>
912
+ // Pass configuration to frontend
913
+ window.docBuilderConfig = {
914
+ features: {
915
+ showPdfDownload: true,
916
+ menuDefaultOpen: true
917
+ }
918
+ };
919
+ </script>
911
920
  <script src="/js/main.js"></script>
912
921
 
913
922
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.290Z",
67
- "dateModified": "2025-07-23T09:32:06.290Z",
66
+ "datePublished": "2025-07-24T08:19:52.276Z",
67
+ "dateModified": "2025-07-24T08:19:52.276Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/launch/go-to-market-strategy.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -638,6 +638,15 @@
638
638
  </div>
639
639
 
640
640
  <!-- Scripts -->
641
+ <script>
642
+ // Pass configuration to frontend
643
+ window.docBuilderConfig = {
644
+ features: {
645
+ showPdfDownload: true,
646
+ menuDefaultOpen: true
647
+ }
648
+ };
649
+ </script>
641
650
  <script src="/js/main.js"></script>
642
651
 
643
652
  </body>
@@ -63,8 +63,8 @@
63
63
  "name": "Knowcode Ltd",
64
64
  "url": "https://knowcode.tech"
65
65
  },
66
- "datePublished": "2025-07-23T09:32:06.297Z",
67
- "dateModified": "2025-07-23T09:32:06.297Z",
66
+ "datePublished": "2025-07-24T08:19:52.282Z",
67
+ "dateModified": "2025-07-24T08:19:52.282Z",
68
68
  "mainEntityOfPage": {
69
69
  "@type": "WebPage",
70
70
  "@id": "https://doc-builder-delta.vercel.app/launch/launch-announcements.html"
@@ -103,7 +103,7 @@
103
103
 
104
104
  <div class="header-actions">
105
105
  <div class="deployment-info">
106
- <span class="deployment-date" title="Built with doc-builder v1.6.3">Last updated: Jul 23, 2025, 09:32 AM UTC</span>
106
+ <span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
107
107
  </div>
108
108
 
109
109
 
@@ -568,6 +568,15 @@ doc-builder deploy
568
568
  </div>
569
569
 
570
570
  <!-- Scripts -->
571
+ <script>
572
+ // Pass configuration to frontend
573
+ window.docBuilderConfig = {
574
+ features: {
575
+ showPdfDownload: true,
576
+ menuDefaultOpen: true
577
+ }
578
+ };
579
+ </script>
571
580
  <script src="/js/main.js"></script>
572
581
 
573
582
  </body>