@knowcode/doc-builder 1.4.15 → 1.4.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/.claude/settings.local.json +2 -1
  2. package/CHANGELOG.md +12 -0
  3. package/Screenshot 2025-07-21 at 17.13.17.png +0 -0
  4. package/Screenshot 2025-07-21 at 17.16.15.png +0 -0
  5. package/html/README.html +5 -5
  6. package/html/claude-workflow-guide.html +5 -5
  7. package/html/documentation-index.html +5 -5
  8. package/html/guides/document-standards.html +5 -5
  9. package/html/index.html +5 -5
  10. package/lib/core-builder.js +40 -6
  11. package/package.json +1 -1
  12. package/scripts/npx-runner.js +0 -0
package/.claude/settings.local.json CHANGED
@@ -17,7 +17,8 @@
17
17
  "Bash(npx:*)",
18
18
  "Bash(grep:*)",
19
19
  "Bash(npm cache clean:*)",
20
- "Bash(ls:*)"
20
+ "Bash(ls:*)",
21
+ "Bash(npm run build:*)"
21
22
  ],
22
23
  "deny": []
23
24
  }
package/CHANGELOG.md CHANGED
@@ -5,6 +5,18 @@ 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.16] - 2025-07-21
9
+
10
+ ### Improved
11
+ - Enhanced menu tooltips to show clean text previews instead of raw markdown
12
+ - Tooltips now display properly formatted text with markdown syntax removed
13
+ - Better preview experience for document summaries
14
+
15
+ ### Background
16
+ - Previously tooltips showed raw markdown including asterisks, links, etc.
17
+ - Now provides clean, readable text excerpts from document content
18
+ - Improves user experience when hovering over menu items
19
+
8
20
  ## [1.4.15] - 2025-07-21
9
21
 
10
22
  ### Fixed
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.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.16">Last updated: Jul 21, 2025, 04:17 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -78,15 +78,15 @@
78
78
  <i class="fas fa-home"></i> Documentation
79
79
  </a>
80
80
  <div class="nav-content" >
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>
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>
81
+ <a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="Claude + CLAUDE.md Documentation Workflow Guide."><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: ✅ Overview."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
84
  <div class="nav-section" data-level="1">
85
85
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
86
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
87
  </a>
88
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>
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="Document Standards for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
90
  </nav>
91
91
  <div class="resize-handle"></div>
92
92
  </aside>
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.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.16">Last updated: Jul 21, 2025, 04:17 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -78,15 +78,15 @@
78
78
  <i class="fas fa-home"></i> Documentation
79
79
  </a>
80
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 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>
81
+ <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item active" data-tooltip="Claude + CLAUDE.md Documentation Workflow Guide."><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: ✅ Overview."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
84
  <div class="nav-section" data-level="1">
85
85
  <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
86
86
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
87
  </a>
88
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>
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="Document Standards for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
90
  </nav>
91
91
  <div class="resize-handle"></div>
92
92
  </aside>
package/html/documentation-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.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.16">Last updated: Jul 21, 2025, 04:17 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -78,15 +78,15 @@
78
78
  <i class="fas fa-home"></i> Documentation
79
79
  </a>
80
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>
81
+ <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="Claude + CLAUDE.md Documentation Workflow Guide."><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: ✅ Overview."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
84
  <div class="nav-section" data-level="1">
85
85
  <a class="nav-title collapsible" href="#" data-target="nav-guides-1" >
86
86
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
87
  </a>
88
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>
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="Document Standards for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
90
  </nav>
91
91
  <div class="resize-handle"></div>
92
92
  </aside>
package/html/guides/document-standards.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.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.16">Last updated: Jul 21, 2025, 04:17 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -78,15 +78,15 @@
78
78
  <i class="fas fa-home"></i> Documentation
79
79
  </a>
80
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>
81
+ <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="Claude + CLAUDE.md Documentation Workflow Guide."><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: ✅ Overview."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
84
  <div class="nav-section" data-level="1">
85
85
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
86
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
87
  </a>
88
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>
89
+ <a href="/guides/document-standards.html" class="nav-item active" data-tooltip="Document Standards for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
90
  </nav>
91
91
  <div class="resize-handle"></div>
92
92
  </aside>
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.14">Last updated: Jul 21, 2025, 04:05 PM UTC</span>
32
+ <span class="deployment-date" title="Built with doc-builder v1.4.16">Last updated: Jul 21, 2025, 04:17 PM UTC</span>
33
33
  </div>
34
34
 
35
35
 
@@ -78,15 +78,15 @@
78
78
  <i class="fas fa-home"></i> Documentation
79
79
  </a>
80
80
  <div class="nav-content" >
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>
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>
81
+ <a href="/README.html" class="nav-item active" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
+ <a href="/claude-workflow-guide.html" class="nav-item" data-tooltip="Claude + CLAUDE.md Documentation Workflow Guide."><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: ✅ Overview."><i class="fas fa-file-alt"></i> Documentation Index</a></div></div>
84
84
  <div class="nav-section" data-level="1">
85
85
  <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
86
  <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
87
  </a>
88
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>
89
+ <a href="/guides/document-standards.html" class="nav-item" data-tooltip="Document Standards for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Document Standards</a></div></div>
90
90
  </nav>
91
91
  <div class="resize-handle"></div>
92
92
  </aside>
package/lib/core-builder.js CHANGED
@@ -29,26 +29,60 @@ function extractSummary(content, maxLength = 150) {
29
29
  // Remove front matter
30
30
  content = content.replace(/^---[\s\S]*?---\n/, '');
31
31
 
32
- // Remove headers
33
- content = content.replace(/^#+\s+.+$/gm, '');
32
+ // Remove headers but keep their text
33
+ content = content.replace(/^#+\s+(.+)$/gm, '$1. ');
34
34
 
35
35
  // Remove code blocks
36
36
  content = content.replace(/```[\s\S]*?```/g, '');
37
37
  content = content.replace(/`[^`]+`/g, '');
38
38
 
39
- // Remove images and links
39
+ // Remove images
40
40
  content = content.replace(/!\[[^\]]*\]\([^)]*\)/g, '');
41
- content = content.replace(/\[[^\]]*\]\([^)]*\)/g, '');
41
+
42
+ // Convert links to just their text
43
+ content = content.replace(/\[([^\]]*)\]\([^)]*\)/g, '$1');
42
44
 
43
45
  // Remove HTML tags
44
46
  content = content.replace(/<[^>]+>/g, '');
45
47
 
46
- // Remove extra whitespace
48
+ // Remove markdown formatting
49
+ content = content.replace(/\*\*([^*]+)\*\*/g, '$1'); // Bold
50
+ content = content.replace(/\*([^*]+)\*/g, '$1'); // Italic
51
+ content = content.replace(/__([^_]+)__/g, '$1'); // Bold
52
+ content = content.replace(/_([^_]+)_/g, '$1'); // Italic
53
+ content = content.replace(/~~([^~]+)~~/g, '$1'); // Strikethrough
54
+
55
+ // Remove blockquotes
56
+ content = content.replace(/^>\s*/gm, '');
57
+
58
+ // Remove list markers
59
+ content = content.replace(/^[-*+]\s+/gm, '');
60
+ content = content.replace(/^\d+\.\s+/gm, '');
61
+
62
+ // Remove horizontal rules
63
+ content = content.replace(/^---+$/gm, '');
64
+ content = content.replace(/^\*\*\*+$/gm, '');
65
+
66
+ // Remove extra whitespace and normalize
47
67
  content = content.trim().replace(/\s+/g, ' ');
48
68
 
69
+ // Skip common metadata patterns at the start
70
+ content = content.replace(/^(Generated|Status|Verified|Date|Author|Version|Updated|Created):\s*[^\n]+\s*/gi, '');
71
+
72
+ // Find the first meaningful content paragraph
73
+ const paragraphs = content.split(/\.\s+/).filter(p => p.trim().length > 20);
74
+ if (paragraphs.length > 0) {
75
+ content = paragraphs[0].trim();
76
+ if (!content.endsWith('.')) {
77
+ content += '.';
78
+ }
79
+ }
80
+
49
81
  // Truncate if needed
50
82
  if (content.length > maxLength) {
51
- content = content.substring(0, maxLength).trim() + '...';
83
+ // Try to cut at a word boundary
84
+ const cutIndex = content.lastIndexOf(' ', maxLength);
85
+ content = content.substring(0, cutIndex > 0 ? cutIndex : maxLength).trim() + '...';
52
86
  }
53
87
 
54
88
  return content || 'No description available';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.4.15",
3
+ "version": "1.4.16",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {
package/scripts/npx-runner.js CHANGED
File without changes