@knowcode/doc-builder 1.5.1 → 1.5.2

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.
@@ -23,7 +23,8 @@
23
23
  "Bash(npm:*)",
24
24
  "Bash(vercel project:*)",
25
25
  "Bash(vercel alias:*)",
26
- "Bash(find:*)"
26
+ "Bash(find:*)",
27
+ "Bash(diff:*)"
27
28
  ],
28
29
  "deny": []
29
30
  }
package/CHANGELOG.md CHANGED
@@ -5,6 +5,24 @@ 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.2] - 2025-07-22
9
+
10
+ ### Added
11
+ - Floating menu button for mobile devices that appears when scrolling down
12
+ - Scroll detection to show/hide floating menu button based on scroll position
13
+ - Smooth animations and transitions for floating button appearance
14
+ - Icon changes between hamburger and close based on sidebar state
15
+
16
+ ### Fixed
17
+ - Fixed mobile menu inaccessibility when scrolled down the page
18
+ - Menu toggle button in header was scrolling off-screen, preventing sidebar access
19
+ - Mobile users can now always access the navigation menu regardless of scroll position
20
+
21
+ ### Background
22
+ - Users reported being unable to open the sidebar menu on mobile when scrolled down
23
+ - Implemented floating action button (FAB) pattern common in mobile apps
24
+ - Button appears when user scrolls past the header and disappears when scrolling back up
25
+
8
26
  ## [1.5.1] - 2025-07-21
9
27
 
10
28
  ### Added
package/README.md CHANGED
@@ -139,14 +139,6 @@ module.exports = {
139
139
  };
140
140
  ```
141
141
 
142
- ## Presets
143
-
144
- Use the `notion-inspired` preset for a clean, modern documentation style:
145
-
146
- ```bash
147
- npx @knowcode/doc-builder build --preset notion-inspired
148
- ```
149
-
150
142
  ## Commands
151
143
 
152
144
  ### set-production-url
@@ -1578,6 +1578,62 @@ tr:hover {
1578
1578
 
1579
1579
  /* Remove custom positioning variables - tooltips always go right */
1580
1580
 
1581
+ /* Floating Menu Button */
1582
+ .floating-menu-toggle {
1583
+ position: fixed;
1584
+ bottom: var(--space-6);
1585
+ right: var(--space-6);
1586
+ width: 56px;
1587
+ height: 56px;
1588
+ border-radius: 50%;
1589
+ background: var(--color-accent-blue);
1590
+ color: white;
1591
+ border: none;
1592
+ box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15), 0 2px 4px rgba(0, 0, 0, 0.1);
1593
+ display: flex;
1594
+ align-items: center;
1595
+ justify-content: center;
1596
+ font-size: 1.25rem;
1597
+ cursor: pointer;
1598
+ z-index: 1001; /* Above sidebar */
1599
+ opacity: 0;
1600
+ transform: scale(0.8) translateY(20px);
1601
+ transition: all var(--duration-normal) var(--easing-out);
1602
+ -webkit-tap-highlight-color: transparent;
1603
+ }
1604
+
1605
+ .floating-menu-toggle.visible {
1606
+ opacity: 1;
1607
+ transform: scale(1) translateY(0);
1608
+ }
1609
+
1610
+ .floating-menu-toggle:hover {
1611
+ transform: scale(1.1) translateY(0);
1612
+ box-shadow: 0 6px 16px rgba(0, 0, 0, 0.2), 0 3px 6px rgba(0, 0, 0, 0.15);
1613
+ }
1614
+
1615
+ .floating-menu-toggle:active {
1616
+ transform: scale(0.95) translateY(0);
1617
+ }
1618
+
1619
+ .floating-menu-toggle i {
1620
+ transition: transform var(--duration-fast) var(--easing-out);
1621
+ }
1622
+
1623
+ .floating-menu-toggle:hover i {
1624
+ transform: rotate(90deg);
1625
+ }
1626
+
1627
+ /* Dark mode styles for floating button */
1628
+ .dark-mode .floating-menu-toggle {
1629
+ background: var(--color-accent-blue);
1630
+ box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3), 0 2px 4px rgba(0, 0, 0, 0.2);
1631
+ }
1632
+
1633
+ .dark-mode .floating-menu-toggle:hover {
1634
+ box-shadow: 0 6px 16px rgba(0, 0, 0, 0.4), 0 3px 6px rgba(0, 0, 0, 0.3);
1635
+ }
1636
+
1581
1637
  /* Mobile adjustments */
1582
1638
  @media (max-width: 768px) {
1583
1639
  /* Disable tooltips on mobile to prevent overlap issues */
package/assets/js/main.js CHANGED
@@ -518,6 +518,92 @@ if (menuToggle) {
518
518
  });
519
519
  }
520
520
 
521
+ // Floating Menu Button for Mobile
522
+ function initFloatingMenuButton() {
523
+ // Only initialize on mobile
524
+ if (window.innerWidth > 768) return;
525
+
526
+ // Check if button already exists
527
+ if (document.getElementById('floating-menu-toggle')) return;
528
+
529
+ // Create floating button
530
+ const floatingButton = document.createElement('button');
531
+ floatingButton.id = 'floating-menu-toggle';
532
+ floatingButton.className = 'floating-menu-toggle';
533
+ floatingButton.setAttribute('aria-label', 'Toggle menu');
534
+ floatingButton.innerHTML = '<i class="fas fa-bars"></i>';
535
+ floatingButton.style.display = 'none'; // Hidden by default
536
+
537
+ // Add to body
538
+ document.body.appendChild(floatingButton);
539
+
540
+ // Toggle sidebar on click
541
+ floatingButton.addEventListener('click', () => {
542
+ sidebar.classList.toggle('open');
543
+ // Update icon based on state
544
+ const icon = floatingButton.querySelector('i');
545
+ if (sidebar.classList.contains('open')) {
546
+ icon.className = 'fas fa-times';
547
+ } else {
548
+ icon.className = 'fas fa-bars';
549
+ }
550
+ });
551
+
552
+ // Show/hide based on scroll position
553
+ let scrollTimeout;
554
+
555
+ window.addEventListener('scroll', () => {
556
+ clearTimeout(scrollTimeout);
557
+ scrollTimeout = setTimeout(() => {
558
+ const scrollTop = window.pageYOffset || document.documentElement.scrollTop;
559
+ const headerHeight = document.querySelector('.header')?.offsetHeight || 64;
560
+
561
+ // Show floating button when scrolled past header
562
+ if (scrollTop > headerHeight + 50) {
563
+ floatingButton.style.display = 'flex';
564
+ // Add slight delay for smooth appearance
565
+ setTimeout(() => {
566
+ floatingButton.classList.add('visible');
567
+ }, 10);
568
+ } else {
569
+ floatingButton.classList.remove('visible');
570
+ // Hide after transition completes
571
+ setTimeout(() => {
572
+ if (!floatingButton.classList.contains('visible')) {
573
+ floatingButton.style.display = 'none';
574
+ }
575
+ }, 300);
576
+ }
577
+ }, 100);
578
+ });
579
+
580
+ // Update icon when sidebar state changes from other sources
581
+ const observer = new MutationObserver(() => {
582
+ const icon = floatingButton.querySelector('i');
583
+ if (sidebar.classList.contains('open')) {
584
+ icon.className = 'fas fa-times';
585
+ } else {
586
+ icon.className = 'fas fa-bars';
587
+ }
588
+ });
589
+
590
+ observer.observe(sidebar, {
591
+ attributes: true,
592
+ attributeFilter: ['class']
593
+ });
594
+ }
595
+
596
+ // Initialize floating button on load and resize
597
+ document.addEventListener('DOMContentLoaded', initFloatingMenuButton);
598
+ window.addEventListener('resize', () => {
599
+ const existingButton = document.getElementById('floating-menu-toggle');
600
+ if (window.innerWidth > 768 && existingButton) {
601
+ existingButton.remove();
602
+ } else if (window.innerWidth <= 768 && !existingButton) {
603
+ initFloatingMenuButton();
604
+ }
605
+ });
606
+
521
607
  // Prevent sidebar from closing when clicking nav items
522
608
  // Only close when clicking outside the sidebar or the close button
523
609
  document.addEventListener('click', (e) => {
package/html/README.html CHANGED
@@ -58,8 +58,8 @@
58
58
  "name": "Knowcode Ltd",
59
59
  "url": "https://knowcode.tech"
60
60
  },
61
- "datePublished": "2025-07-21T20:39:06.468Z",
62
- "dateModified": "2025-07-21T20:39:06.468Z",
61
+ "datePublished": "2025-07-22T05:55:46.703Z",
62
+ "dateModified": "2025-07-22T05:55:46.703Z",
63
63
  "mainEntityOfPage": {
64
64
  "@type": "WebPage",
65
65
  "@id": "https://doc-builder-delta.vercel.app/README.html"
@@ -92,7 +92,7 @@
92
92
 
93
93
  <div class="header-actions">
94
94
  <div class="deployment-info">
95
- <span class="deployment-date" title="Built with doc-builder v1.5.0">Last updated: Jul 21, 2025, 08:39 PM UTC</span>
95
+ <span class="deployment-date" title="Built with doc-builder v1.5.1">Last updated: Jul 22, 2025, 05:55 AM UTC</span>
96
96
  </div>
97
97
 
98
98
 
@@ -142,7 +142,6 @@
142
142
  </a>
143
143
  <div class="nav-content" >
144
144
  <a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
145
- <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
146
145
  <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>
147
146
  <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>
148
147
  <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>
@@ -152,6 +151,7 @@
152
151
  </a>
153
152
  <div class="nav-content" id="nav-guides-1">
154
153
  <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
154
+ <a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
155
155
  <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
156
156
  <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>
157
157
  <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></div></div>
@@ -58,8 +58,8 @@
58
58
  "name": "Knowcode Ltd",
59
59
  "url": "https://knowcode.tech"
60
60
  },
61
- "datePublished": "2025-07-21T20:39:06.478Z",
62
- "dateModified": "2025-07-21T20:39:06.478Z",
61
+ "datePublished": "2025-07-21T20:43:20.146Z",
62
+ "dateModified": "2025-07-21T20:43:20.146Z",
63
63
  "mainEntityOfPage": {
64
64
  "@type": "WebPage",
65
65
  "@id": "https://doc-builder-delta.vercel.app/claude-workflow-guide.html"
@@ -92,7 +92,7 @@
92
92
 
93
93
  <div class="header-actions">
94
94
  <div class="deployment-info">
95
- <span class="deployment-date" title="Built with doc-builder v1.5.0">Last updated: Jul 21, 2025, 08:39 PM UTC</span>
95
+ <span class="deployment-date" title="Built with doc-builder v1.5.1">Last updated: Jul 21, 2025, 08:43 PM UTC</span>
96
96
  </div>
97
97
 
98
98
 
@@ -1578,6 +1578,62 @@ tr:hover {
1578
1578
 
1579
1579
  /* Remove custom positioning variables - tooltips always go right */
1580
1580
 
1581
+ /* Floating Menu Button */
1582
+ .floating-menu-toggle {
1583
+ position: fixed;
1584
+ bottom: var(--space-6);
1585
+ right: var(--space-6);
1586
+ width: 56px;
1587
+ height: 56px;
1588
+ border-radius: 50%;
1589
+ background: var(--color-accent-blue);
1590
+ color: white;
1591
+ border: none;
1592
+ box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15), 0 2px 4px rgba(0, 0, 0, 0.1);
1593
+ display: flex;
1594
+ align-items: center;
1595
+ justify-content: center;
1596
+ font-size: 1.25rem;
1597
+ cursor: pointer;
1598
+ z-index: 1001; /* Above sidebar */
1599
+ opacity: 0;
1600
+ transform: scale(0.8) translateY(20px);
1601
+ transition: all var(--duration-normal) var(--easing-out);
1602
+ -webkit-tap-highlight-color: transparent;
1603
+ }
1604
+
1605
+ .floating-menu-toggle.visible {
1606
+ opacity: 1;
1607
+ transform: scale(1) translateY(0);
1608
+ }
1609
+
1610
+ .floating-menu-toggle:hover {
1611
+ transform: scale(1.1) translateY(0);
1612
+ box-shadow: 0 6px 16px rgba(0, 0, 0, 0.2), 0 3px 6px rgba(0, 0, 0, 0.15);
1613
+ }
1614
+
1615
+ .floating-menu-toggle:active {
1616
+ transform: scale(0.95) translateY(0);
1617
+ }
1618
+
1619
+ .floating-menu-toggle i {
1620
+ transition: transform var(--duration-fast) var(--easing-out);
1621
+ }
1622
+
1623
+ .floating-menu-toggle:hover i {
1624
+ transform: rotate(90deg);
1625
+ }
1626
+
1627
+ /* Dark mode styles for floating button */
1628
+ .dark-mode .floating-menu-toggle {
1629
+ background: var(--color-accent-blue);
1630
+ box-shadow: 0 4px 12px rgba(0, 0, 0, 0.3), 0 2px 4px rgba(0, 0, 0, 0.2);
1631
+ }
1632
+
1633
+ .dark-mode .floating-menu-toggle:hover {
1634
+ box-shadow: 0 6px 16px rgba(0, 0, 0, 0.4), 0 3px 6px rgba(0, 0, 0, 0.3);
1635
+ }
1636
+
1581
1637
  /* Mobile adjustments */
1582
1638
  @media (max-width: 768px) {
1583
1639
  /* Disable tooltips on mobile to prevent overlap issues */
@@ -58,8 +58,8 @@
58
58
  "name": "Knowcode Ltd",
59
59
  "url": "https://knowcode.tech"
60
60
  },
61
- "datePublished": "2025-07-21T20:39:06.481Z",
62
- "dateModified": "2025-07-21T20:39:06.481Z",
61
+ "datePublished": "2025-07-22T05:55:46.714Z",
62
+ "dateModified": "2025-07-22T05:55:46.714Z",
63
63
  "mainEntityOfPage": {
64
64
  "@type": "WebPage",
65
65
  "@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
@@ -92,7 +92,7 @@
92
92
 
93
93
  <div class="header-actions">
94
94
  <div class="deployment-info">
95
- <span class="deployment-date" title="Built with doc-builder v1.5.0">Last updated: Jul 21, 2025, 08:39 PM UTC</span>
95
+ <span class="deployment-date" title="Built with doc-builder v1.5.1">Last updated: Jul 22, 2025, 05:55 AM UTC</span>
96
96
  </div>
97
97
 
98
98
 
@@ -142,7 +142,6 @@
142
142
  </a>
143
143
  <div class="nav-content" >
144
144
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
145
- <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
146
145
  <a href="/documentation-index.html" class="nav-item active" 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>
147
146
  <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>
148
147
  <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>
@@ -152,6 +151,7 @@
152
151
  </a>
153
152
  <div class="nav-content collapsed" id="nav-guides-1">
154
153
  <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
154
+ <a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
155
155
  <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
156
156
  <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>
157
157
  <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></div></div>
@@ -58,8 +58,8 @@
58
58
  "name": "Knowcode Ltd",
59
59
  "url": "https://knowcode.tech"
60
60
  },
61
- "datePublished": "2025-07-21T20:39:06.483Z",
62
- "dateModified": "2025-07-21T20:39:06.483Z",
61
+ "datePublished": "2025-07-22T05:55:46.716Z",
62
+ "dateModified": "2025-07-22T05:55:46.716Z",
63
63
  "mainEntityOfPage": {
64
64
  "@type": "WebPage",
65
65
  "@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
@@ -98,7 +98,7 @@
98
98
 
99
99
  <div class="header-actions">
100
100
  <div class="deployment-info">
101
- <span class="deployment-date" title="Built with doc-builder v1.5.0">Last updated: Jul 21, 2025, 08:39 PM UTC</span>
101
+ <span class="deployment-date" title="Built with doc-builder v1.5.1">Last updated: Jul 22, 2025, 05:55 AM UTC</span>
102
102
  </div>
103
103
 
104
104
 
@@ -148,7 +148,6 @@
148
148
  </a>
149
149
  <div class="nav-content" >
150
150
  <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
151
- <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
152
151
  <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>
153
152
  <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>
154
153
  <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>
@@ -158,6 +157,7 @@
158
157
  </a>
159
158
  <div class="nav-content" id="nav-guides-1">
160
159
  <a href="/guides/authentication-guide.html" class="nav-item active" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
160
+ <a href="/guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
161
161
  <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</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/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></div></div>