@knowcode/doc-builder 1.4.12 → 1.4.15

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.
Files changed (10) hide show
  1. package/.claude/settings.local.json +3 -1
  2. package/CHANGELOG.md +37 -0
  3. package/README.md +12 -0
  4. package/html/README.html +10 -3
  5. package/html/claude-workflow-guide.html +9 -2
  6. package/html/documentation-index.html +241 -0
  7. package/html/guides/document-standards.html +517 -0
  8. package/html/index.html +10 -3
  9. package/lib/core-builder.js +9 -3
  10. package/package.json +6 -5
package/.claude/settings.local.json CHANGED
@@ -15,7 +15,9 @@
15
15
  "Bash(git rebase:*)",
16
16
  "Bash(npm info:*)",
17
17
  "Bash(npx:*)",
18
- "Bash(grep:*)"
18
+ "Bash(grep:*)",
19
+ "Bash(npm cache clean:*)",
20
+ "Bash(ls:*)"
19
21
  ],
20
22
  "deny": []
21
23
  }
package/CHANGELOG.md CHANGED
@@ -5,6 +5,43 @@ 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.4.15] - 2025-07-21
9
+
10
+ ### Fixed
11
+ - Fixed index.html not being regenerated with current doc-builder version
12
+ - index.html is now always regenerated from README.html to ensure version consistency
13
+ - This prevents stale version numbers from being shown in deployed documentation
14
+
15
+ ### Background
16
+ - Previously, index.html was preserved if it existed and looked valid
17
+ - This caused version numbers to be stuck at older versions
18
+ - Now ensures index.html always reflects the current build version
19
+
20
+ ## [1.4.14] - 2025-07-21
21
+
22
+ ### Fixed
23
+ - Fixed subdirectories not showing on initial page load
24
+ - Folders now expand by default when viewing index.html or root README
25
+ - Improved navigation visibility for better user experience
26
+
27
+ ### Background
28
+ - Previously, folders only expanded if they contained the active page
29
+ - This caused subdirectories to be hidden on initial page load
30
+ - Now folders expand automatically for better content discovery
31
+
32
+ ## [1.4.13] - 2025-07-21
33
+
34
+ ### Added
35
+ - Created comprehensive DOCUMENT-STANDARDS.md defining documentation conventions
36
+ - Added documentation index file for better navigation
37
+ - Established docs/guides/ directory structure for organized documentation
38
+
39
+ ### Documentation
40
+ - Document standards cover naming conventions, content guidelines, and quality standards
41
+ - Includes templates for different document types (features, technical guides, API docs)
42
+ - Defines metadata requirements and verification indicators (✅/❓)
43
+ - Establishes changelog maintenance practices
44
+
8
45
  ## [1.4.12] - 2025-07-21
9
46
 
10
47
  ### Fixed
package/README.md CHANGED
@@ -4,6 +4,18 @@ Beautiful documentation with the least effort possible. A zero-configuration doc
4
4
 
5
5
  🔗 **[View Live Example](https://doc-builder-delta.vercel.app)** - See what your documentation will look like!
6
6
 
7
+ ## Recent Documentation Updates (Last 14 Days)
8
+
9
+ ### 🚀 System & Deployment (docs:)
10
+ - 🔄 **UPDATE**: [Claude + CLAUDE.md Documentation Workflow Guide](docs/claude-workflow-guide.md) - Documentation updates and improvements
11
+ - 🔄 **MAJOR UPDATE**: [Documentation Index](docs/documentation-index.md) - Significant updates with enhanced functionality and coverage
12
+ - 🔄 **MAJOR UPDATE**: [Document Standards for @knowcode/doc-builder](docs/guides/DOCUMENT-STANDARDS.md) - Significant updates with enhanced functionality and coverage
13
+ - 🔄 **UPDATE**: [@knowcode/doc-builder](docs/README.md) - Documentation updates and improvements
14
+ - 🔄 **UPDATE**: [Document Standards for @knowcode/doc-builder](docs/guides/document-standards.md) - Documentation updates and improvements
15
+
16
+ **Total Changes**: 0+ new documents, 5+ updates and improvements across 5 files
17
+
18
+
7
19
  ## Why This Project Exists
8
20
 
9
21
  The main premise of @knowcode/doc-builder is simple: **create beautiful documentation with the least effort possible**. We believe great documentation shouldn't require complex setup, configuration files, or deployment headaches. Just write markdown, run one command, and get a professional documentation site live on the web.
package/html/README.html CHANGED
@@ -29,7 +29,7 @@
29
29
 
30
30
  <div class="header-actions">
31
31
  <div class="deployment-info">
32
- <span class="deployment-date" title="Built with doc-builder v1.4.11">Last updated: Jul 21, 2025, 12:20 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -79,7 +79,14 @@
79
79
  </a>
80
80
  <div class="nav-content" >
81
81
  <a href="/README.html" class="nav-item active" data-tooltip="&gt; Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
82
- <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a></div></div>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
83
+ <a href="/documentation-index.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This directory contains additional documentation for the @knowcode/doc-builde..."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
+ <div class="nav-section" data-level="1">
85
+ <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
+ </a>
88
+ <div class="nav-content" id="nav-guides-1">
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This document defines the documentation standards and conventions for the @kn..."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
83
90
  </nav>
84
91
  <div class="resize-handle"></div>
85
92
  </aside>
@@ -98,7 +105,7 @@
98
105
  npm install -g @knowcode/doc-builder
99
106
 
100
107
  # Or use with npx
101
- npx @knowcode/doc-builder@latest init
108
+ npx @knowcode/doc-builder@latest deploy
102
109
  </code></pre>
103
110
  <h2>✨ Features</h2>
104
111
  <h3>🎨 Beautiful Design</h3>
package/html/claude-workflow-guide.html CHANGED
@@ -29,7 +29,7 @@
29
29
 
30
30
  <div class="header-actions">
31
31
  <div class="deployment-info">
32
- <span class="deployment-date" title="Built with doc-builder v1.4.11">Last updated: Jul 21, 2025, 12:20 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -79,7 +79,14 @@
79
79
  </a>
80
80
  <div class="nav-content" >
81
81
  <a href="/README.html" class="nav-item" data-tooltip="&gt; Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
82
- <a href="/claude-workflow-guide.html" class="nav-item active" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a></div></div>
82
+ <a href="/claude-workflow-guide.html" class="nav-item active" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
83
+ <a href="/documentation-index.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This directory contains additional documentation for the @knowcode/doc-builde..."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
+ <div class="nav-section" data-level="1">
85
+ <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
86
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
+ </a>
88
+ <div class="nav-content collapsed" id="nav-guides-1">
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This document defines the documentation standards and conventions for the @kn..."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
83
90
  </nav>
84
91
  <div class="resize-handle"></div>
85
92
  </aside>
package/html/documentation-index.html ADDED
@@ -0,0 +1,241 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <meta name="description" content="Documentation site built with @knowcode/doc-builder">
7
+ <title>Documentation Index - Documentation</title>
8
+
9
+ <!-- Fonts -->
10
+ <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
11
+
12
+ <!-- Icons -->
13
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
14
+
15
+ <!-- Mermaid -->
16
+ <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
17
+
18
+ <!-- Styles -->
19
+ <link rel="stylesheet" href="/css/notion-style.css">
20
+
21
+ <!-- Favicon -->
22
+ <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
23
+ </head>
24
+ <body>
25
+ <!-- Header -->
26
+ <header class="header">
27
+ <div class="header-content">
28
+ <a href="/index.html" class="logo">Documentation</a>
29
+
30
+ <div class="header-actions">
31
+ <div class="deployment-info">
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
33
+ </div>
34
+
35
+
36
+
37
+ <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
38
+ <i class="fas fa-moon"></i>
39
+ </button>
40
+
41
+ <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
42
+ <i class="fas fa-bars"></i>
43
+ </button>
44
+ </div>
45
+ </div>
46
+ </header>
47
+
48
+ <!-- Preview Banner -->
49
+ <div id="preview-banner" class="preview-banner">
50
+ <div class="banner-content">
51
+ <i class="fas fa-exclamation-triangle banner-icon"></i>
52
+ <span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
53
+ <button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
54
+ <i class="fas fa-times"></i>
55
+ </button>
56
+ </div>
57
+ </div>
58
+
59
+ <!-- Breadcrumbs -->
60
+ <nav class="breadcrumbs" id="breadcrumbs">
61
+ <!-- Breadcrumbs will be generated by JavaScript -->
62
+ </nav>
63
+
64
+ <!-- Main Content -->
65
+ <div class="main-wrapper">
66
+ <!-- Sidebar -->
67
+ <aside class="sidebar">
68
+ <div class="sidebar-header">
69
+ <div class="filter-box">
70
+ <input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
71
+ <i class="fas fa-search filter-icon"></i>
72
+ </div>
73
+ </div>
74
+ <nav class="navigation">
75
+
76
+ <div class="nav-section" data-level="0">
77
+ <a class="nav-title expanded" href="/README.html" >
78
+ <i class="fas fa-home"></i> Documentation
79
+ </a>
80
+ <div class="nav-content" >
81
+ <a href="/README.html" class="nav-item" data-tooltip="&gt; Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
83
+ <a href="/documentation-index.html" class="nav-item active" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This directory contains additional documentation for the @knowcode/doc-builde..."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
+ <div class="nav-section" data-level="1">
85
+ <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
86
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
+ </a>
88
+ <div class="nav-content collapsed" id="nav-guides-1">
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This document defines the documentation standards and conventions for the @kn..."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
+ </nav>
91
+ <div class="resize-handle"></div>
92
+ </aside>
93
+
94
+ <!-- Content Area -->
95
+ <main class="content">
96
+ <div class="content-inner">
97
+ <h1>Documentation Index</h1>
98
+ <p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
99
+ <h2>Overview</h2>
100
+ <p>This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose.</p>
101
+ <h2>Directory Structure</h2>
102
+ <pre><code>docs/
103
+ ├── README.md # NPM readme (auto-generated)
104
+ ├── documentation-index.md # This file - documentation map
105
+ ├── claude-workflow-guide.md # AI workflow guide
106
+ └── guides/ # How-to guides and standards
107
+ └── DOCUMENT-STANDARDS.md # Documentation standards
108
+ </code></pre>
109
+ <h2>Documentation Categories</h2>
110
+ <h3>📚 Core Documentation</h3>
111
+ <table>
112
+ <thead>
113
+ <tr>
114
+ <th>Document</th>
115
+ <th>Location</th>
116
+ <th>Description</th>
117
+ </tr>
118
+ </thead>
119
+ <tbody><tr>
120
+ <td>Project Overview</td>
121
+ <td><a href="../README.md">../README.md</a></td>
122
+ <td>Main project documentation</td>
123
+ </tr>
124
+ <tr>
125
+ <td>Change Log</td>
126
+ <td><a href="../CHANGELOG.md">../CHANGELOG.md</a></td>
127
+ <td>Version history and updates</td>
128
+ </tr>
129
+ <tr>
130
+ <td>AI Assistant Guide</td>
131
+ <td><a href="../CLAUDE.md">../CLAUDE.md</a></td>
132
+ <td>Claude Code integration guide</td>
133
+ </tr>
134
+ </tbody></table>
135
+ <h3>📖 Guides</h3>
136
+ <table>
137
+ <thead>
138
+ <tr>
139
+ <th>Document</th>
140
+ <th>Location</th>
141
+ <th>Description</th>
142
+ </tr>
143
+ </thead>
144
+ <tbody><tr>
145
+ <td>Document Standards</td>
146
+ <td><a href="./guides/DOCUMENT-STANDARDS.md">guides/DOCUMENT-STANDARDS.md</a></td>
147
+ <td>How to write docs for this project</td>
148
+ </tr>
149
+ <tr>
150
+ <td>Claude Workflow</td>
151
+ <td><a href="./claude-workflow-guide.md">claude-workflow-guide.md</a></td>
152
+ <td>Using Claude with doc-builder</td>
153
+ </tr>
154
+ </tbody></table>
155
+ <h3>🔜 Coming Soon</h3>
156
+ <ul>
157
+ <li><strong>API Reference</strong> - Detailed API documentation</li>
158
+ <li><strong>Architecture Guide</strong> - System design and components</li>
159
+ <li><strong>Troubleshooting</strong> - Common issues and solutions</li>
160
+ <li><strong>Plugin Development</strong> - Extending doc-builder</li>
161
+ <li><strong>Migration Guide</strong> - Upgrading from older versions</li>
162
+ </ul>
163
+ <h2>Quick Start Guides</h2>
164
+ <h3>For Users</h3>
165
+ <ol>
166
+ <li><strong>Installation</strong>: See <a href="../README.md#quick-start">README.md</a></li>
167
+ <li><strong>Configuration</strong>: Check <a href="../CLAUDE.md#configuration">CLAUDE.md</a></li>
168
+ <li><strong>Deployment</strong>: Follow <a href="../README.md#deployment">README.md</a></li>
169
+ </ol>
170
+ <h3>For Contributors</h3>
171
+ <ol>
172
+ <li><strong>Standards</strong>: Read <a href="./guides/DOCUMENT-STANDARDS.md">DOCUMENT-STANDARDS.md</a></li>
173
+ <li><strong>Development</strong>: See <a href="../CLAUDE.md#development-guidelines">CLAUDE.md</a></li>
174
+ <li><strong>Testing</strong>: Check <a href="../CLAUDE.md#testing-changes">CLAUDE.md</a></li>
175
+ </ol>
176
+ <h2>Contributing Documentation</h2>
177
+ <p>When adding new documentation:</p>
178
+ <ol>
179
+ <li><strong>Follow Standards</strong>: Use <a href="./guides/DOCUMENT-STANDARDS.md">DOCUMENT-STANDARDS.md</a></li>
180
+ <li><strong>Choose Location</strong>: Place in appropriate subdirectory</li>
181
+ <li><strong>Update Index</strong>: Add to this file</li>
182
+ <li><strong>Include Metadata</strong>: Add headers as per standards</li>
183
+ <li><strong>Test Examples</strong>: Verify all code snippets work</li>
184
+ </ol>
185
+ <h3>Documentation Template</h3>
186
+ <pre><code class="language-markdown"># Document Title
187
+
188
+ **Generated**: YYYY-MM-DD HH:MM UTC
189
+ **Status**: Draft/Complete
190
+ **Verified**: ✅/❓
191
+
192
+ ## Overview
193
+
194
+ Brief description...
195
+
196
+ ## Main Content
197
+
198
+ Detailed information...
199
+
200
+ ## Document History
201
+
202
+ | Date | Version | Author | Changes |
203
+ |------|---------|--------|---------|
204
+ | YYYY-MM-DD | 1.0 | Name | Initial creation |
205
+ </code></pre>
206
+ <h2>Maintenance</h2>
207
+ <p>Documentation should be reviewed:</p>
208
+ <ul>
209
+ <li>With each minor version release</li>
210
+ <li>When features change</li>
211
+ <li>Quarterly for accuracy</li>
212
+ <li>When issues are reported</li>
213
+ </ul>
214
+ <hr>
215
+ <h2>Document History</h2>
216
+ <table>
217
+ <thead>
218
+ <tr>
219
+ <th>Date</th>
220
+ <th>Version</th>
221
+ <th>Author</th>
222
+ <th>Changes</th>
223
+ </tr>
224
+ </thead>
225
+ <tbody><tr>
226
+ <td>2025-07-21</td>
227
+ <td>1.0</td>
228
+ <td>System</td>
229
+ <td>Initial documentation index</td>
230
+ </tr>
231
+ </tbody></table>
232
+
233
+ </div>
234
+ </main>
235
+ </div>
236
+
237
+ <!-- Scripts -->
238
+ <script src="/js/main.js"></script>
239
+
240
+ </body>
241
+ </html>
package/html/guides/document-standards.html ADDED
@@ -0,0 +1,517 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <meta name="description" content="Documentation site built with @knowcode/doc-builder">
7
+ <title>Document Standards for @knowcode/doc-builder - Documentation</title>
8
+
9
+ <!-- Fonts -->
10
+ <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
11
+
12
+ <!-- Icons -->
13
+ <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
14
+
15
+ <!-- Mermaid -->
16
+ <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
17
+
18
+ <!-- Styles -->
19
+ <link rel="stylesheet" href="/css/notion-style.css">
20
+
21
+ <!-- Favicon -->
22
+ <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>📚</text></svg>">
23
+ </head>
24
+ <body>
25
+ <!-- Header -->
26
+ <header class="header">
27
+ <div class="header-content">
28
+ <a href="/index.html" class="logo">Documentation</a>
29
+
30
+ <div class="header-actions">
31
+ <div class="deployment-info">
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
33
+ </div>
34
+
35
+
36
+
37
+ <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
38
+ <i class="fas fa-moon"></i>
39
+ </button>
40
+
41
+ <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
42
+ <i class="fas fa-bars"></i>
43
+ </button>
44
+ </div>
45
+ </div>
46
+ </header>
47
+
48
+ <!-- Preview Banner -->
49
+ <div id="preview-banner" class="preview-banner">
50
+ <div class="banner-content">
51
+ <i class="fas fa-exclamation-triangle banner-icon"></i>
52
+ <span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
53
+ <button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
54
+ <i class="fas fa-times"></i>
55
+ </button>
56
+ </div>
57
+ </div>
58
+
59
+ <!-- Breadcrumbs -->
60
+ <nav class="breadcrumbs" id="breadcrumbs">
61
+ <!-- Breadcrumbs will be generated by JavaScript -->
62
+ </nav>
63
+
64
+ <!-- Main Content -->
65
+ <div class="main-wrapper">
66
+ <!-- Sidebar -->
67
+ <aside class="sidebar">
68
+ <div class="sidebar-header">
69
+ <div class="filter-box">
70
+ <input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
71
+ <i class="fas fa-search filter-icon"></i>
72
+ </div>
73
+ </div>
74
+ <nav class="navigation">
75
+
76
+ <div class="nav-section" data-level="0">
77
+ <a class="nav-title" href="/README.html" >
78
+ <i class="fas fa-home"></i> Documentation
79
+ </a>
80
+ <div class="nav-content" >
81
+ <a href="/README.html" class="nav-item" data-tooltip="&gt; Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
83
+ <a href="/documentation-index.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This directory contains additional documentation for the @knowcode/doc-builde..."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
+ <div class="nav-section" data-level="1">
85
+ <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
+ </a>
88
+ <div class="nav-content" id="nav-guides-1">
89
+ <a href="/guides/document-standards.html" class="nav-item active" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This document defines the documentation standards and conventions for the @kn..."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
+ </nav>
91
+ <div class="resize-handle"></div>
92
+ </aside>
93
+
94
+ <!-- Content Area -->
95
+ <main class="content">
96
+ <div class="content-inner">
97
+ <h1>Document Standards for @knowcode/doc-builder</h1>
98
+ <p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
99
+ <h2>Overview</h2>
100
+ <p>This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project should follow these guidelines to ensure consistency, clarity, and maintainability.</p>
101
+ <h2>Document Structure Standards</h2>
102
+ <h3>Document Header Format</h3>
103
+ <p>Every document MUST include the following metadata at the top:</p>
104
+ <pre><code class="language-markdown"># Document Title
105
+
106
+ **Generated**: YYYY-MM-DD HH:MM UTC
107
+ **Status**: Draft/In Progress/Complete
108
+ **Verified**: ✅ (for verified information) / ❓ (for speculated information)
109
+
110
+ ## Overview
111
+
112
+ Brief description of the document&#39;s contents and purpose.
113
+ </code></pre>
114
+ <h3>Section Organization</h3>
115
+ <ol>
116
+ <li><strong>Title</strong> (H1) - Single, descriptive title</li>
117
+ <li><strong>Metadata</strong> - Generation date, status, verification</li>
118
+ <li><strong>Overview</strong> - Brief summary of document purpose</li>
119
+ <li><strong>Main Content</strong> - Organized with clear headings</li>
120
+ <li><strong>Document History</strong> - Track significant changes</li>
121
+ </ol>
122
+ <h2>Naming Conventions</h2>
123
+ <h3>Document File Names</h3>
124
+ <p>Use lowercase with hyphens, following these patterns:</p>
125
+ <ul>
126
+ <li><strong>Feature Documentation</strong>: <code>feature-{name}-guide.md</code></li>
127
+ <li><strong>API Documentation</strong>: <code>api-{endpoint}-reference.md</code></li>
128
+ <li><strong>Technical Guides</strong>: <code>{component}-{topic}-guide.md</code></li>
129
+ <li><strong>Architecture Documents</strong>: <code>architecture-{system}-overview.md</code></li>
130
+ <li><strong>Implementation Plans</strong>: <code>plan-{feature}-implementation.md</code></li>
131
+ <li><strong>Analysis Documents</strong>: <code>analysis-{topic}-{specifics}.md</code></li>
132
+ <li><strong>Troubleshooting Guides</strong>: <code>troubleshoot-{issue}-guide.md</code></li>
133
+ <li><strong>Change Logs</strong>: <code>CHANGELOG.md</code> (always uppercase)</li>
134
+ </ul>
135
+ <h3>Special Files</h3>
136
+ <ul>
137
+ <li><code>README.md</code> - Project overview and getting started</li>
138
+ <li><code>CHANGELOG.md</code> - Version history following Keep a Changelog format</li>
139
+ <li><code>CLAUDE.md</code> - AI assistant guidance (project-specific)</li>
140
+ <li><code>DOCUMENT-STANDARDS.md</code> - This file</li>
141
+ </ul>
142
+ <h2>Content Standards</h2>
143
+ <h3>1. Mermaid Diagrams</h3>
144
+ <p>Include diagrams wherever they help explain complex concepts:</p>
145
+ <pre><code class="language-markdown"><div class="mermaid-wrapper">
146
+ <div class="mermaid-title">Diagram</div>
147
+ <div class="mermaid">graph TD
148
+ A[User Input] --> B{Valid?}
149
+ B -->|Yes| C[Process]
150
+ B -->|No| D[Error]
151
+ C --> E[Output]
152
+
153
+ style A fill:#f9f,stroke:#333,stroke-width:2px
154
+ style E fill:#9f9,stroke:#333,stroke-width:2px</div>
155
+ </div>
156
+ </code></pre>
157
+ <p>Guidelines:</p>
158
+ <ul>
159
+ <li>Use consistent node naming</li>
160
+ <li>Add clear labels and descriptions</li>
161
+ <li>Apply styling for better visual hierarchy</li>
162
+ <li>Include diagram titles where appropriate</li>
163
+ </ul>
164
+ <h3>2. Information Verification</h3>
165
+ <p>Mark all information with verification status:</p>
166
+ <ul>
167
+ <li>✅ <strong>Verified</strong>: Information confirmed through testing or official sources</li>
168
+ <li>❓ <strong>Speculated</strong>: Assumptions or unconfirmed information</li>
169
+ <li>⚠️ <strong>Warning</strong>: Important caveats or potential issues</li>
170
+ <li>🚧 <strong>In Progress</strong>: Features or documentation under development</li>
171
+ </ul>
172
+ <p>Example:</p>
173
+ <pre><code class="language-markdown">### Feature Status
174
+ - ✅ **Markdown parsing**: Fully implemented and tested
175
+ - ❓ **Performance impact**: Estimated 100ms for 50 files
176
+ - ⚠️ **Large files**: May timeout on files &gt; 10MB
177
+ - 🚧 **Search feature**: Currently in development
178
+ </code></pre>
179
+ <h3>3. Code Examples</h3>
180
+ <p>Always include practical, tested examples:</p>
181
+ <pre><code class="language-javascript">// Good example - with context and error handling
182
+ const { build } = require(&#39;@knowcode/doc-builder&#39;);
183
+
184
+ const config = {
185
+ siteName: &#39;My Documentation&#39;,
186
+ docsDir: &#39;./docs&#39;,
187
+ outputDir: &#39;./dist&#39;
188
+ };
189
+
190
+ try {
191
+ await build(config);
192
+ console.log(&#39;✅ Build successful&#39;);
193
+ } catch (error) {
194
+ console.error(&#39;❌ Build failed:&#39;, error.message);
195
+ }
196
+ </code></pre>
197
+ <p>Guidelines:</p>
198
+ <ul>
199
+ <li>Use syntax highlighting</li>
200
+ <li>Include error handling</li>
201
+ <li>Add helpful comments</li>
202
+ <li>Show both correct and incorrect usage</li>
203
+ <li>Test all examples before documenting</li>
204
+ </ul>
205
+ <h3>4. Command Examples</h3>
206
+ <p>Format commands clearly with descriptions:</p>
207
+ <pre><code class="language-bash"># Install the package
208
+ npm install -D @knowcode/doc-builder
209
+
210
+ # Build documentation
211
+ npx doc-builder build
212
+
213
+ # Start development server
214
+ npx doc-builder dev --port 3000
215
+
216
+ # Deploy to Vercel
217
+ npx doc-builder deploy --prod
218
+ </code></pre>
219
+ <h2>Version Control Standards</h2>
220
+ <h3>Changelog Management</h3>
221
+ <p>ALWAYS maintain <code>CHANGELOG.md</code> for all significant or material changes:</p>
222
+ <pre><code class="language-markdown">## [1.4.12] - 2025-07-21
223
+
224
+ ### Fixed
225
+ - Fixed h1 title alignment to extend full width
226
+ - Added negative margins to counteract padding
227
+
228
+ ### Background
229
+ - The h1 was appearing offset due to content padding
230
+ - Now extends full width for better hierarchy
231
+ </code></pre>
232
+ <p>Categories:</p>
233
+ <ul>
234
+ <li><strong>Added</strong> - New features</li>
235
+ <li><strong>Changed</strong> - Changes to existing functionality</li>
236
+ <li><strong>Deprecated</strong> - Soon-to-be removed features</li>
237
+ <li><strong>Removed</strong> - Removed features</li>
238
+ <li><strong>Fixed</strong> - Bug fixes</li>
239
+ <li><strong>Security</strong> - Security fixes</li>
240
+ <li><strong>Background</strong> - Context for the changes</li>
241
+ </ul>
242
+ <h3>Commit Messages</h3>
243
+ <p>Follow conventional commits:</p>
244
+ <ul>
245
+ <li><code>feat:</code> New features</li>
246
+ <li><code>fix:</code> Bug fixes</li>
247
+ <li><code>docs:</code> Documentation changes</li>
248
+ <li><code>chore:</code> Maintenance tasks</li>
249
+ <li><code>refactor:</code> Code refactoring</li>
250
+ <li><code>test:</code> Test additions/changes</li>
251
+ </ul>
252
+ <h2>Markdown Best Practices</h2>
253
+ <h3>Headers</h3>
254
+ <pre><code class="language-markdown"># Main Title (H1 - one per document)
255
+
256
+ ## Major Section (H2)
257
+
258
+ ### Subsection (H3)
259
+
260
+ #### Detail Level (H4)
261
+ </code></pre>
262
+ <ul>
263
+ <li>Use hierarchical structure</li>
264
+ <li>Don&#39;t skip levels</li>
265
+ <li>Keep headers concise but descriptive</li>
266
+ </ul>
267
+ <h3>Lists</h3>
268
+ <p>Unordered lists for non-sequential items:</p>
269
+ <pre><code class="language-markdown">- First item
270
+ - Second item
271
+ - Nested item
272
+ - Another nested item
273
+ - Third item
274
+ </code></pre>
275
+ <p>Numbered lists for sequential steps:</p>
276
+ <pre><code class="language-markdown">1. First step
277
+ 2. Second step
278
+ 3. Third step
279
+ </code></pre>
280
+ <h3>Tables</h3>
281
+ <p>Keep tables readable and well-formatted:</p>
282
+ <pre><code class="language-markdown">| Feature | Status | Version | Notes |
283
+ |---------|--------|---------|-------|
284
+ | Mermaid | ✅ Ready | 1.0.0 | Full support |
285
+ | Search | 🚧 WIP | 1.5.0 | In development |
286
+ | Auth | ✅ Ready | 1.3.0 | Optional feature |
287
+ </code></pre>
288
+ <h3>Links</h3>
289
+ <ul>
290
+ <li>Use descriptive link text: <code>[View deployment guide](./deploy.md)</code></li>
291
+ <li>Avoid: <code>[click here](./deploy.md)</code></li>
292
+ <li>Prefer relative links for internal docs</li>
293
+ <li>Use absolute URLs for external resources</li>
294
+ </ul>
295
+ <h2>Quality Standards</h2>
296
+ <h3>Clarity</h3>
297
+ <ul>
298
+ <li>Write for your target audience</li>
299
+ <li>Define technical terms on first use</li>
300
+ <li>Use simple language where possible</li>
301
+ <li>Include examples for complex concepts</li>
302
+ </ul>
303
+ <h3>Completeness</h3>
304
+ <ul>
305
+ <li>Cover all aspects of the topic</li>
306
+ <li>Include edge cases and limitations</li>
307
+ <li>Document prerequisites</li>
308
+ <li>Provide troubleshooting guidance</li>
309
+ </ul>
310
+ <h3>Accuracy</h3>
311
+ <ul>
312
+ <li>Verify all technical details</li>
313
+ <li>Test code examples</li>
314
+ <li>Update when implementation changes</li>
315
+ <li>Mark speculation clearly</li>
316
+ </ul>
317
+ <h3>Consistency</h3>
318
+ <ul>
319
+ <li>Use same terminology throughout</li>
320
+ <li>Follow naming conventions</li>
321
+ <li>Maintain style consistency</li>
322
+ <li>Cross-reference related documents</li>
323
+ </ul>
324
+ <h2>Document Types</h2>
325
+ <h3>1. Feature Documentation</h3>
326
+ <p>Structure:</p>
327
+ <pre><code class="language-markdown"># Feature Name
328
+
329
+ **Generated**: [date]
330
+ **Status**: Complete
331
+ **Verified**: ✅
332
+
333
+ ## Overview
334
+ What the feature does and why it exists
335
+
336
+ ## Usage
337
+ How to use the feature with examples
338
+
339
+ ## Configuration
340
+ Available options and settings
341
+
342
+ ## Examples
343
+ Practical use cases
344
+
345
+ ## Troubleshooting
346
+ Common issues and solutions
347
+ </code></pre>
348
+ <h3>2. Technical Guides</h3>
349
+ <p>Structure:</p>
350
+ <pre><code class="language-markdown"># Technical Guide: [Topic]
351
+
352
+ **Generated**: [date]
353
+ **Status**: Complete
354
+ **Verified**: ✅
355
+
356
+ ## Overview
357
+ Technical context and goals
358
+
359
+ ## Architecture
360
+ System design and components
361
+
362
+ ## Implementation
363
+ Step-by-step technical details
364
+
365
+ ## Testing
366
+ How to verify functionality
367
+
368
+ ## Performance
369
+ Benchmarks and optimization
370
+ </code></pre>
371
+ <h3>3. API Documentation</h3>
372
+ <p>Structure:</p>
373
+ <pre><code class="language-markdown"># API: [Endpoint/Function Name]
374
+
375
+ **Generated**: [date]
376
+ **Status**: Complete
377
+ **Verified**: ✅
378
+
379
+ ## Overview
380
+ What the API does
381
+
382
+ ## Parameters
383
+ | Name | Type | Required | Description |
384
+ |------|------|----------|-------------|
385
+
386
+ ## Response
387
+ Expected response format
388
+
389
+ ## Examples
390
+ Request/response examples
391
+
392
+ ## Error Handling
393
+ Possible errors and meanings
394
+ </code></pre>
395
+ <h2>File Organization</h2>
396
+ <h3>Directory Structure</h3>
397
+ <pre><code>doc-builder/
398
+ ├── README.md # Project overview
399
+ ├── CHANGELOG.md # Version history
400
+ ├── CLAUDE.md # AI assistant guide
401
+ ├── DOCUMENT-STANDARDS.md # This file
402
+ ├── docs/ # Additional documentation
403
+ │ ├── guides/ # How-to guides
404
+ │ ├── api/ # API documentation
405
+ │ ├── architecture/ # System design docs
406
+ │ └── troubleshooting/ # Problem-solving guides
407
+ </code></pre>
408
+ <h3>File Management</h3>
409
+ <ul>
410
+ <li>Keep active documentation in appropriate directories</li>
411
+ <li>Archive outdated docs with date suffix: <code>old-guide-2025-01-15.md</code></li>
412
+ <li>Remove unused files after archiving</li>
413
+ <li>Maintain README.md in each directory explaining contents</li>
414
+ </ul>
415
+ <h2>Special Considerations</h2>
416
+ <h3>Security</h3>
417
+ <ul>
418
+ <li>Never include credentials or API keys</li>
419
+ <li>Use placeholders for sensitive data: <code>API_KEY=&lt;your-api-key-here&gt;</code></li>
420
+ <li>Document security implications</li>
421
+ <li>Include security warnings where relevant</li>
422
+ </ul>
423
+ <h3>Performance</h3>
424
+ <ul>
425
+ <li>Document performance characteristics</li>
426
+ <li>Include benchmarks where applicable</li>
427
+ <li>Note resource requirements</li>
428
+ <li>Provide optimization tips</li>
429
+ </ul>
430
+ <h3>Accessibility</h3>
431
+ <ul>
432
+ <li>Use clear, simple language</li>
433
+ <li>Provide alt text for images</li>
434
+ <li>Structure documents logically</li>
435
+ <li>Consider screen reader users</li>
436
+ </ul>
437
+ <h2>Document Maintenance</h2>
438
+ <h3>Review Schedule</h3>
439
+ <ul>
440
+ <li>Technical docs: Review with each minor version</li>
441
+ <li>API docs: Review with any API change</li>
442
+ <li>Guides: Review quarterly</li>
443
+ <li>README: Update with significant changes</li>
444
+ </ul>
445
+ <h3>Update Process</h3>
446
+ <ol>
447
+ <li>Check document metadata</li>
448
+ <li>Verify technical accuracy</li>
449
+ <li>Update examples</li>
450
+ <li>Test code snippets</li>
451
+ <li>Update changelog</li>
452
+ <li>Commit with descriptive message</li>
453
+ </ol>
454
+ <h3>Document History</h3>
455
+ <p>Include at the bottom of long-lived documents:</p>
456
+ <pre><code class="language-markdown">## Document History
457
+
458
+ | Date | Version | Author | Changes |
459
+ |------|---------|--------|---------|
460
+ | 2025-07-21 | 1.0 | System | Initial creation |
461
+ | 2025-07-22 | 1.1 | Dev | Added examples |
462
+ </code></pre>
463
+ <h2>Tools and Automation</h2>
464
+ <h3>Building Documentation</h3>
465
+ <p>The doc-builder automatically:</p>
466
+ <ul>
467
+ <li>Generates navigation from folder structure</li>
468
+ <li>Extracts summaries for tooltips</li>
469
+ <li>Renders mermaid diagrams</li>
470
+ <li>Applies syntax highlighting</li>
471
+ <li>Creates responsive layouts</li>
472
+ </ul>
473
+ <h3>Preview Changes</h3>
474
+ <pre><code class="language-bash"># Preview documentation locally
475
+ npx doc-builder dev
476
+
477
+ # Build and check output
478
+ npx doc-builder build
479
+ open html/index.html
480
+ </code></pre>
481
+ <h2>Conclusion</h2>
482
+ <p>Following these standards ensures:</p>
483
+ <ul>
484
+ <li>Consistent, professional documentation</li>
485
+ <li>Easy navigation and discovery</li>
486
+ <li>Clear communication of technical concepts</li>
487
+ <li>Maintainable documentation over time</li>
488
+ </ul>
489
+ <p>Remember: Good documentation is as important as good code. It enables others (including your future self) to understand, use, and maintain the project effectively.</p>
490
+ <hr>
491
+ <h2>Document History</h2>
492
+ <table>
493
+ <thead>
494
+ <tr>
495
+ <th>Date</th>
496
+ <th>Version</th>
497
+ <th>Author</th>
498
+ <th>Changes</th>
499
+ </tr>
500
+ </thead>
501
+ <tbody><tr>
502
+ <td>2025-07-21</td>
503
+ <td>1.0</td>
504
+ <td>System</td>
505
+ <td>Initial creation from project standards</td>
506
+ </tr>
507
+ </tbody></table>
508
+
509
+ </div>
510
+ </main>
511
+ </div>
512
+
513
+ <!-- Scripts -->
514
+ <script src="/js/main.js"></script>
515
+
516
+ </body>
517
+ </html>
package/html/index.html CHANGED
@@ -29,7 +29,7 @@
29
29
 
30
30
  <div class="header-actions">
31
31
  <div class="deployment-info">
32
- <span class="deployment-date" title="Built with doc-builder v1.4.11">Last updated: Jul 21, 2025, 12:17 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -79,7 +79,14 @@
79
79
  </a>
80
80
  <div class="nav-content" >
81
81
  <a href="/README.html" class="nav-item active" data-tooltip="&gt; Transform your markdown documentation into beautiful, searchable websites with Notion-inspired styling Create stunning documentation sites in minute..."><i class="fas fa-file-alt"></i> Overview</a>
82
- <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a></div></div>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 10:00 UTC **Status**: Complete **Verified**: ✅ This guide demonstrates an efficient workflow for using Claude Code with a re..."><i class="fas fa-file-alt"></i> Claude Workflow Guide</a>
83
+ <a href="/documentation-index.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This directory contains additional documentation for the @knowcode/doc-builde..."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
+ <div class="nav-section" data-level="1">
85
+ <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
+ <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
+ </a>
88
+ <div class="nav-content" id="nav-guides-1">
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="**Generated**: 2025-07-21 18:00 UTC **Status**: Complete **Verified**: ✅ This document defines the documentation standards and conventions for the @kn..."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
83
90
  </nav>
84
91
  <div class="resize-handle"></div>
85
92
  </aside>
@@ -98,7 +105,7 @@
98
105
  npm install -g @knowcode/doc-builder
99
106
 
100
107
  # Or use with npx
101
- npx @knowcode/doc-builder@latest init
108
+ npx @knowcode/doc-builder@latest deploy
102
109
  </code></pre>
103
110
  <h2>✨ Features</h2>
104
111
  <h3>🎨 Beautiful Design</h3>
package/lib/core-builder.js CHANGED
@@ -332,15 +332,17 @@ function buildNavigationStructure(files, currentFile) {
332
332
  const folderDescription = folderDescriptions[folderName] || '';
333
333
  const tooltipAttr = folderDescription ? `data-tooltip="${escapeHtml(folderDescription)}"` : '';
334
334
 
335
- // Start all sections collapsed by default (JavaScript will expand sections containing active items)
335
+ // Check if this folder has active child or if we're on index page
336
336
  const hasActiveChild = checkActiveChild(folderData, currentFile);
337
+ // Expand all folders by default on initial page load (index.html or root README)
338
+ const shouldExpand = hasActiveChild || currentFile === 'index.html' || (currentFile === 'README.html' && level === 1);
337
339
 
338
340
  let html = `
339
341
  <div class="nav-section" data-level="${level}">
340
- <a class="nav-title${isCollapsible ? ' collapsible' : ''}${hasActiveChild ? ' expanded' : ''}" ${folderLink} ${isCollapsible ? `data-target="${sectionId}"` : ''} ${tooltipAttr}>
342
+ <a class="nav-title${isCollapsible ? ' collapsible' : ''}${shouldExpand ? ' expanded' : ''}" ${folderLink} ${isCollapsible ? `data-target="${sectionId}"` : ''} ${tooltipAttr}>
341
343
  ${collapseIcon}<i class="${icon}"></i> ${displayName}
342
344
  </a>
343
- <div class="nav-content${isCollapsible ? (hasActiveChild ? '' : ' collapsed') : ''}" ${isCollapsible ? `id="${sectionId}"` : ''}>`;
345
+ <div class="nav-content${isCollapsible ? (shouldExpand ? '' : ' collapsed') : ''}" ${isCollapsible ? `id="${sectionId}"` : ''}>`;
344
346
 
345
347
  // Sort and render files
346
348
  const sortedFiles = [...folderData.files].sort((a, b) => {
@@ -584,6 +586,10 @@ async function buildDocumentation(config) {
584
586
  if (!fs.existsSync(indexPath)) {
585
587
  console.log(chalk.yellow('⚠️ index.html does not exist, need to create it'));
586
588
  shouldCreateIndex = true;
589
+ } else if (fs.existsSync(readmePath)) {
590
+ // If README.html exists, always regenerate index.html from it to ensure current version
591
+ console.log(chalk.blue('ℹ️ Regenerating index.html from README.html to ensure current version'));
592
+ shouldCreateIndex = true;
587
593
  } else {
588
594
  // Check if existing index.html is likely a directory listing or outdated
589
595
  const indexStats = fs.statSync(indexPath);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.4.12",
3
+ "version": "1.4.15",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -21,12 +21,13 @@
21
21
  "author": "KnowCode",
22
22
  "license": "MIT",
23
23
  "dependencies": {
24
- "marked": "^15.0.12",
25
- "commander": "^11.0.0",
24
+ "@knowcode/doc-builder": "^1.4.14",
26
25
  "chalk": "^4.1.2",
27
- "prompts": "^2.4.2",
26
+ "commander": "^11.0.0",
27
+ "fs-extra": "^11.2.0",
28
+ "marked": "^15.0.12",
28
29
  "ora": "5.4.1",
29
- "fs-extra": "^11.2.0"
30
+ "prompts": "^2.4.2"
30
31
  },
31
32
  "engines": {
32
33
  "node": ">=14.0.0"